> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Search

> Search ClickHouse documentation, changelogs, blogs, website pages, and GitHub issues.

export const GlobalSearch = ({placeholder = 'Search ClickHouse docs...'}) => {
  const previewUrlPattern = /^https?:\/\/private-7c7dfe99\.mintlify\.(?:app|site)\/(?:docs(?:\/|(?=[?#]|$)))?/;
  const transformSource = source => {
    let url = source.url || '';
    const isPreview = previewUrlPattern.test(url);
    if (isPreview) {
      url = url.replace(previewUrlPattern, 'https://clickhouse.com/docs/');
    }
    const tabs = [];
    if (isPreview || (/clickhouse\.com\/docs(\/|$)/).test(url)) {
      tabs.push('Docs');
    } else if (url.indexOf('github.com') !== -1 && (/\/issues(\/|$)/).test(url)) tabs.push('Docs'); else if ((/\/blog(\/|$)/).test(url)) tabs.push('Docs'); else if (url.indexOf('clickhouse.com') !== -1) tabs.push('Docs');
    return Object.assign({}, source, {
      tabs,
      url
    });
  };
  const ref = useRef(null);
  useEffect(() => {
    const el = ref.current;
    if (!el || el.dataset.inkeepMounted === '1') return;
    window.__globalSearchSeq = (window.__globalSearchSeq || 0) + 1;
    const targetId = 'inkeep-global-search-' + window.__globalSearchSeq;
    el.id = targetId;
    const keyStaging = 'd3e2792740610240ff7bcf2c2a78a33012812eb4f3e34d54';
    const keyLocal = 'b25e5cf856ec9da60d250578b59dace8417359feeedcbc6b';
    const apiKey = (/\.mintlify\.(?:app|site)$/).test(window.location.hostname) ? keyStaging : keyLocal;
    const embedUrl = 'https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5/dist/embed.js';
    const config = {
      baseSettings: {
        apiKey,
        organizationDisplayName: 'ClickHouse',
        primaryBrandColor: '#fdff75',
        transformSource,
        colorMode: {
          sync: {
            target: document.documentElement,
            attributes: ['class'],
            isDarkMode: attributes => (attributes && attributes.class || '').indexOf('dark') !== -1
          }
        },
        theme: {
          styles: [{
            key: 'hide-single-tab',
            type: 'style',
            value: '.ikp-ai-search-results__tab-list { display: none !important; }'
          }, {
            key: 'section-search-box',
            type: 'style',
            value: ['.ikp-ai-search-input-group {', '  border-radius: 6px;', '  background: var(--background-light, #ffffff);', '  box-shadow: 0 0 0 1px rgb(156 163 175 / 0.3);', '  padding-top: 0;', '  padding-bottom: 0;', '  min-height: 2.25rem;', '}', '.ikp-ai-search-input { min-height: 0; }', '.ikp-ai-search-results__list { margin-top: 0.5rem !important; }', '.ikp-ai-search-input-group:hover {', '  box-shadow: 0 0 0 1px rgb(75 85 99 / 0.3);', '}', '.dark .ikp-ai-search-input-group {', '  background: var(--background-dark, #151515);', '  box-shadow: 0 0 0 1px rgb(75 85 99 / 0.3);', '  filter: brightness(1.1);', '}', '.dark .ikp-ai-search-input-group:hover {', '  box-shadow: 0 0 0 1px rgb(107 114 128 / 0.3);', '  filter: brightness(1.25);', '}'].join('\n')
          }]
        }
      },
      searchSettings: {
        placeholder,
        debounceTimeMs: 300,
        maxResults: 20,
        shouldShowContentSnippets: true,
        contentSnippetLength: 200,
        shouldHighlightMatches: true,
        tabs: ['Docs']
      }
    };
    let cancelled = false;
    let widget = null;
    const mount = () => {
      if (cancelled || el.dataset.inkeepMounted === '1') return;
      const api = window.__inkeepEmbedJs || window.Inkeep;
      if (!api || typeof api.EmbeddedSearch !== 'function') {
        requestAnimationFrame(mount);
        return;
      }
      el.dataset.inkeepMounted = '1';
      try {
        widget = api.EmbeddedSearch('#' + targetId, config);
      } catch (error) {
        console.log('Inkeep global search failed:', error);
      }
    };
    const loadEmbed = trap => {
      if (trap && !window.__inkeepTrapped) {
        const modalInkeep = window.Inkeep;
        if (!window.__inkeepEmbedJs && modalInkeep && typeof modalInkeep.EmbeddedSearch === 'function') {
          window.__inkeepEmbedJs = modalInkeep;
        }
        try {
          Object.defineProperty(window, 'Inkeep', {
            configurable: true,
            get: function () {
              return modalInkeep;
            },
            set: function (value) {
              window.__inkeepEmbedJs = value;
            }
          });
          window.__inkeepTrapped = true;
        } catch (error) {}
      }
      if (!document.getElementById('inkeep-embed-js-script')) {
        const script = document.createElement('script');
        script.id = 'inkeep-embed-js-script';
        script.type = 'module';
        script.src = embedUrl;
        script.onload = () => {
          const embedApi = window.__inkeepEmbedJs || window.Inkeep;
          if (embedApi && typeof embedApi.EmbeddedSearch === 'function') {
            window.__inkeepEmbedJs = embedApi;
          }
          mount();
        };
        document.head.appendChild(script);
      }
      mount();
    };
    let frames = 0;
    const waitForModal = () => {
      if (cancelled) return;
      if (window.__inkeepEmbedJs) {
        mount();
        return;
      }
      const modalReady = window.Inkeep && typeof window.Inkeep.ModalSearchAndChat === 'function';
      if (modalReady) {
        loadEmbed(true);
        return;
      }
      if (frames > 480) {
        loadEmbed(false);
        return;
      }
      frames++;
      requestAnimationFrame(waitForModal);
    };
    waitForModal();
    return () => {
      cancelled = true;
      try {
        if (widget && typeof widget.unmount === 'function') widget.unmount(); else if (widget && typeof widget.destroy === 'function') widget.destroy();
      } catch (error) {}
      if (el) el.dataset.inkeepMounted = '';
    };
  }, [placeholder]);
  return <div ref={ref} className="not-prose" style={{
    margin: '1.25rem 0'
  }} />;
};

Search across ClickHouse documentation and other ClickHouse resources.

<GlobalSearch placeholder="Search ClickHouse docs..." />