Skip to content

Files

compass-query-bar

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Apr 18, 2025
May 17, 2022
May 17, 2022
Apr 24, 2024
Apr 24, 2024
Nov 30, 2022
Apr 21, 2025
May 17, 2022
May 17, 2022

Compass Query Bar

Renders a component for executing MongoDB queries through a GUI

Usage

Browser

Setting values via configure:

import Plugin, {
  configureStore,
  configureActions,
} from '@mongodb-js/compass-query-bar';

const actions = configureActions();
const store = configureStore({
  localAppRegistry: appRegistry,
  actions: actions,
  namespace: 'db.coll',
  serverVersion: '4.2.0',
  fields: [],
});

<Plugin store={store} actions={actions} />;

Hadron/Electron

const role = appRegistry.getRole('Query.QueryBar')[0];
const Plugin = role.component;
const configureStore = role.configureStore;
const configureActions = role.configureActions;

const actions = configureActions();
const store = configureStore({
  globalAppRegistry: appRegistry,
  localAppRegistry: localAppRegistry,
  actions: actions,
  namespace: 'db.coll',
  serverVersion: '4.2.0',
  fields: [],
});

<Plugin store={store} actions={actions} />;

Fields

The fields array must be an array of objects that the ACE editor autocompleter understands. See This example for what that array looks like.