Skip to content
This repository has been archived by the owner on May 17, 2021. It is now read-only.

Renders a component for executing MongoDB queries through a GUI.

License

Notifications You must be signed in to change notification settings

mongodb-js/compass-query-bar

Repository files navigation

Compass Query Bar

Renders a component for executing MongoDB queries through a GUI.

License

Apache 2.0

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.