beekeeper-studio README

The project's README from github.com/beekeeper-studio/beekeeper-studio. As one markdown file: README.md.

🌐 EN | PT-BR | ES | DE | FR | EL | JA | IT | KO | ID | SW

Beekeeper Studio

Beekeeper Studio is a cross-platform SQL editor and database manager available for Linux, Mac, and Windows.

Download Beekeeper Studio

We publish binaries for MacOS, Windows, and Linux.

image

Beekeeper Studio is free to download and provides a lot of features for free, no sign-up, registration, or credit card required. The app provides some premium features for a reasonable cost license fee. Learn more here

Most of the code in this repo is open source under the GPLv3 license. Paid features are also in this repository under a commercial source-available license.

We welcome community contributions!

Supported Databases

Database Support Community Paid Editions Beekeeper Links
PostgreSQL ⭐ Full Support ✅ ✅ Features
MySQL ⭐ Full Support ✅ ✅ Features
SQLite ⭐ Full Support ✅ ✅ Features, Docs
SQL Server ⭐ Full Support ✅ ✅ Features
Amazon Redshift ⭐ Full Support ✅ ✅ Features
CockroachDB ⭐ Full Support ✅ ✅ Features, Docs
MariaDB ⭐ Full Support ✅ ✅ Features
TiDB ⭐ Full Support ✅ ✅ Features
Google BigQuery ⭐ Full Support ✅ ✅ Features, Docs
Redis ⭐ Full Support ✅ ✅ Features, Docs
GreengageDB ⭐ Full Support ✅ ✅ Docs
Oracle Database ⭐ Full Support ✅ Features, Docs
Cassandra ⭐ Full Support ✅ Features
ScyllaDB ⭐ Full Support (via Cassandra driver) ✅ Drop-in compatible with Cassandra
Firebird ⭐ Full Support ✅ Features, Docs
LibSQL ⭐ Full Support ✅ Features
ClickHouse ⭐ Full Support ✅ Features, Docs
DuckDB ⭐ Full Support ✅ Features, Docs
SQL Anywhere ⭐ Full Support ✅ Features
MongoDB ⭐ Full Support ✅ Features, Docs
Trino / Presto ⭐ Full Support ✅ Features, Docs
SurrealDB ⭐ Full Support ✅ Docs
DynamoDB 🧪 Beta Support ✅ Features, Docs
Snowflake ⏳ Coming Soon ✅ --

Editions of Beekeeper Studio

Beekeeper Studio is a single download with in-app upgrades for premium features.

We'd love to make Beekeeper Studio totally free for everyone, but building good software is hard work and expensive. We think our paid editions are fairly priced, I hope you do too.

👉 Compare Beekeeper Studio Editions

Beekeeper Studio Features

Top feature: It's smooth 🍫, fast 🏎, and you'll actually enjoy using it 🥰

Our approach to UX

One of our frustrations with other open-source SQL editors and database managers is that they take a 'kitchen sink' approach to features, adding so many features that the UI becomes cluttered and hard to navigate. We wanted a good looking, open source SQL workbench that's powerful, but also easy to use. We couldn't find one, so we created Beekeeper Studio!

Generally our guiding star is to only build software that 'feels good' to use. That means at the very least we value Beekeeper being fast, straightforward to use, and modern. If a new feature compromises this vision, we kill it.

Supporting Beekeeper Studio

We love working on Beekeeper Studio, and we'd love to keep growing and improving it forever. To do that I need your help.

The best way to support Beekeeper Studio is to purchase a paid license. Every purchase directly supports our work on Beekeeper Studio.

If you're at a business and using Beekeeper Studio for your job, you should probably get your boss to buy you a license.

If you can't afford a license, please use the free version, that's why we make a free version!

Thank you for your continued support!

Documentation

Check out docs.beekeeperstudio.io for user guides, FAQs, troubleshooting tips, and more.

License

Beekeeper Studio Community Edition (the code in this repository) is licensed under the GPLv3 license.

Beekeeper Studio Ultimate Edition contains extra features and is licensed under a commercial end user agreement (EULA).

Beekeeper Studio's trademarks (words marks and logos) are not open source. See our trademark guidelines for more information.

Third party assets bundled with the app, such as the database icons, are credited in ATTRIBUTIONS.md.

Trademark Guidelines

Trademarks can be complicated with open source projects, so we have adapted a set of standard guidelines for using our trademarks that are common to many open source projects.

If you are just using the Beekeeper Studio app, and you are not forking or distributing Beekeeper Studio code in any way, these probably don't apply to you.

👉 Beekeeper Studio Trademark Guidelines

Contributing to Beekeeper Studio

We love any community engagement. Even if you're complaining because you don't like something about the app!

Contributor Agreements

Contribute without coding

We have you covered, read our guide to contributing in 10 minutes without coding.

Compiling and Running Beekeeper Studio Locally

Want to write some code and improve Beekeeper Studio? Getting set-up is easy on Mac, Linux, or Windows.

# First: Install NodeJS 20, NPM, and Yarn
# ...

# 1. Fork the Beekeeper Studio Repo (click fork button at top right of this screen)
# 2. Check out your fork:
git clone [email protected]:<your-username>/beekeeper-studio.git beekeeper-studio
cd beekeeper-studio/
yarn set version classic
nvm use 22
yarn install # installs dependencies


# Now you can start the app:
yarn run electron:serve ## the app will now start

If you get error:03000086:digital envelope routines::initialization error, you'll have to update openssl.

sudo apt-get update
sudo apt-get upgrade openssl
sudo yum update openssl
brew update
brew upgrade openssl

Where to make changes?

This repo is now a monorepo, we have several places with code, but only really a couple of important entry points.

All app code lives in apps/studio, some shared code lives in shared/src. This is shared with other apps.

Beekeeper Studio has two entry points:

Generally we have two 'screens':

How to submit a change?

Maintainer notes (casual readers can ignore this stuff)

Upgrading Electron Gotchas

This is always a total pain and will break the build 9/10.

Some things you need to consider when upgrading Electron:

  1. Does it use a different node version. Eg Electron-18 uses node 14, 22 uses node 16. So everyone needs to upgrade
  2. Does node-abi need to be upgraded to be able to understand the electron version? This is used in the build to fetch prebuilt packages. You need to upgrade this in root/package.json#resolutions
  3. Were any APIs deprecated or removed? Make sure all features that interact with the Electron APIs still work, stuff like - selecting a file, maximizing a window, running a query, etc.

Release Process

  1. Up the version number in package.json
  2. Replace build/release-notes.md with the latest release notes. Follow the format that is there.
  1. Commit
  2. Push to master
  3. Create a tag git tag v<version>. It must start with a 'v'
  4. git push origin <tagname>
  1. Push the new release live

This should also publish the latest docs

Post Release:

  1. Copy release notes to a blog post, post on website
  2. Tweet link
  3. Share on LinkedIn
  4. Send to mailing list on SendInBlue

Big Thanks

Beekeeper Studio wouldn't exist without Sqlectron-core, the core database libraries from the Sqlectron project. Beekeeper Studio started as an experimental fork of that repository. A big thanks to @maxcnunes and the rest of the Sqlectron community.

The original license from sqlectron-core is included here:

Copyright (c) 2015 The SQLECTRON Team

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

beekeeper-studio (beekeeper-studio/beekeeper-studio)

Searching Database…

Что это такое?Beekeeper Studio — кроссплатформенный редактор SQL и менеджер баз данных для MySQL, Postgres, SQLite, SQL Server и многих других баз. Его создали так, чтобы он работал быстро и без лишнего нагромождения по сравнению с другими графическими инструментами для баз данных.
Это настольное приложение или инструмент для браузера?Это нативное настольное приложение, созданное на Electron и Vue.js. Оно распространяется в виде готовых бинарных сборок для Mac, Windows и Linux, а не как программа, которую запускают в браузере.
Как его запустить?Скачайте готовую сборку для своей ОС и установите её напрямую. Бесплатная версия не требует регистрации, создания аккаунта или банковской карты. Чтобы собрать программу из исходников, клонируйте монорепозиторий и запустите скрипты bks:build/bks:dev, которые работают через yarn.
Получу ли я полную поддержку всех баз данных бесплатно?Нет. Основные движки, такие как PostgreSQL, MySQL, SQLite, SQL Server, MariaDB и BigQuery, имеют полную поддержку от сообщества (бесплатную). Но многие другие, например Oracle, Cassandra, MongoDB, ClickHouse, DuckDB и Firebird, доступны только в платных редакциях, а поддержка Snowflake пока помечена как «Скоро».
Это для отдельных разработчиков или и для компаний тоже?И для тех, и для других. Частные лица могут пользоваться бесплатной версией для личных задач. Но проект прямо просит компании, сотрудники которых используют программу в работе, приобрести платную лицензию, чтобы поддержать разработку.
Что на самом деле входит в бесплатную версию?Бесплатная Community Edition даёт полноценное редактирование SQL: автодополнение, подсветку синтаксиса, вкладки, историю запросов, тёмную тему, импорт/экспорт, резервное копирование/восстановление. Всё это доступно для основных баз данных, таких как Postgres, MySQL, SQLite, SQL Server и MariaDB.
Почему команда создала этот продукт, а не стала использовать другой открытый SQL-клиент?Авторы сочли, что существующие открытые инструменты для баз данных перегружены функциями по принципу «всё и сразу», из-за чего интерфейс становится захламлённым. Поэтому они создали рабочее пространство, которое ориентировано прежде всего на скорость, простоту и современный вид.
На чём изначально была основана Beekeeper Studio?Она начиналась как экспериментальный форк Sqlectron-core, то есть библиотек для подключения к базам данных из проекта Sqlectron.
What are similar projects?TablePro, dbx, tabularis, Chat2DB, GoNavi, tusk, orm, typeorm
Size
130.3 MB
Stars
23.8K
Age
7y
Commits · 90 Days