Pular para o conteúdo
NoSqlStudio
Documentação

Plugin Marketplace

Navegue, instale, e gerencie plugins da comunidade. Todo bundle `.nbplugin` é SHA-256 verificado no momento da instalação; plugins rodam num sandbox de renderer com permissões declaradas em manifest.

O que é

Uma tab de workspace listando plugins aprovados do marketplace moderado (https://nosqlstudio.com/marketplace/plugins) mais seu conjunto instalado localmente. Plugins estendem o NoSqlStudio com tabs de workspace, classifiers de datamask, variantes de tema, query inspectors, e ações de menu. Exemplos: Geo Heatmap (plota qualquer field GeoJSON num mapa), BSONSize Profiler (análise de storage per-collection), KPI Card Builder (cards de dashboard customizados).

Quando usar

Instale plugins quando o feature set built-in não atende uma necessidade específica — geralmente uma visualização domain-specific ou uma integração one-off. O marketplace deixa você descobrir plugins; este workspace gerencia o conjunto instalado.

Como abrir

  1. No app desktop do NoSqlStudio, abra o menu Tools → Plugin Marketplace, ou pressione Ctrl+Alt+Shift+G.
  2. O workspace abre com duas colunas: plugins instalados à esquerda, um pane Browse buscando o catálogo do marketplace à direita.
  3. Clique num plugin no pane Browse para ver seu manifest, permissões, screenshots, e fingerprint SHA-256. Clique em Install para baixar.

Instalando um plugin

  1. Browse — busque por nome ou tag. Cada card mostra o autor, permissões declaradas, e contagem de install.
  2. Verify — o marketplace publica o SHA-256 do bundle + manifest. O installer local se recusa a escrever o bundle no disco se o hash real diferir.
  3. Permissions — revise o que o plugin pede: workspace mount, fetch (quais hosts), DataService read/write, telemetry. Recuse se qualquer permissão parecer excessiva para a função declarada.
  4. Install — o engine extrai o bundle para userData/Plugins/<plugin-id>/, registra a entry, e recarrega as surfaces afetadas.
  5. Uninstall / disable — todo plugin instalado tem um toggle e um botão remove. Disabling não deleta; remoção limpa a pasta userData.

Submetendo seu próprio plugin

Construa com o @mongodb-js/compass-plugin-sdk, empacote num zip `.nbplugin` (manifest.json + JS bundle), depois submeta em https://nosqlstudio.com/marketplace/submit. Moderadores verificam o manifest + SHA-256 em até 5 dias úteis.

Limitações (v1)

  • Plugins rodam no processo renderer, não isolados. Um plugin malicioso com permissões amplas pode ler secrets de conexão. Audite o manifest antes de instalar.
  • Hot-reload após install requer que o workspace afetado seja fechado e reaberto. A primeira instalação de um plugin que registra um workspace tab precisa de um reload completo do app (Cmd/Ctrl+R).
  • Fallback do marketplace — se o catálogo central está unreachable, o workspace mostra um cache stale (ou os sample plugins built-in no first run).