gStore

gStore — это система управления базами данных с графовой структурой, предназначенная для работы с большими объёмами данных. Система является open-source и ориентирована на работу в Linux. Проект написан на C++, с использованием некоторых библиотек, таких как readline, antlr и др. В настоящее время предоставляются только исходные tar-архивы, что означает необходимость компиляции исходного кода перед использованием gStore.

Официальная документация по помощи доступна на английском языке (EN) и китайском языке (ZH):

• Официальная документация по помощи на английском языке: docs/help/gStore_help.pdf;
• Официальная документация по помощи на китайском языке: docs/help/gStore_help_ZH.pdf.

Официальные результаты экспериментов доступны по ссылке:

• Официальные результаты экспериментов: docs/test/formal_experiment.pdf.

Мы создали IRC-канал под названием #gStore на freenode, и вы можете посетить домашнюю страницу gStore по адресу: http://gstore-pku.com.

Начало работы

Компиляция из исходного кода

Эта система действительно удобна для пользователя, и вы сможете освоить её за несколько минут. Не забудьте проверить свою платформу, на которой вы хотите запустить эту систему, просмотрев системные требования (docs/DEMAND.md). После того как всё будет проверено, пожалуйста, получите исходный код проекта. Есть несколько способов сделать это:

— (рекомендуется) введите «git clone https://github.com/pkumod/gStore.git» в своём терминале или используйте графический интерфейс git для его получения; — загрузите zip-архив из этого репозитория и извлеките его; — создайте форк этого репозитория в своей учётной записи GitHub.

Затем вам нужно скомпилировать проект. В первый раз вам необходимо ввести команду «make pre», чтобы подготовить библиотеку ANTLR и некоторые программы Lexer/Parser. Позже вам не нужно вводить эту команду снова, просто используйте команду «make» в домашнем каталоге gStore, после чего будут созданы все исполняемые файлы. (Для ускорения скорости компиляции используйте «make -j4» вместо этого, используя количество потоков в зависимости от вашей машины.) Чтобы проверить правильность программы, введите команду «make test».

Первая стратегия рекомендуется для получения исходного кода, потому что вы можете легко получать обновления кода, вводя «git pull» в домашний каталог репозитория gStore. Кроме того, вы можете напрямую проверить версию кода, введя «git log», чтобы увидеть журналы фиксации. Если вы хотите использовать код из других веток вместо основной ветки, например, ветку «dev», то:

— клонируйте основную ветку и введите «git checkout dev» в вашем терминале; — непосредственно клонируйте ветку «dev», введя «git clone -b dev».

Развёртывание через Docker

Вы можете легко развернуть gStore через Docker. Мы предоставляем как Dockerfile, так и образ Docker. Пожалуйста, ознакомьтесь с нашими документами по развёртыванию Docker (EN): docs/DOCKER_DEPLOY_EN.md или документами по развёртыванию Docker на китайском языке (中文): docs/DOCKER_DEPLOY_CN.md для получения подробной информации.

Запуск

Чтобы запустить gStore, введите «bin/gbuild database_name dataset_path», чтобы создать базу данных с именем, которое вы укажете. И вы можете использовать команду «bin/gquery database_name», чтобы запросить существующую базу данных. Более того, «bin/ghttp» — это замечательный инструмент, разработанный для вас как сервер базы данных, к которому можно получить доступ через протокол HTTP. Обратите внимание, что все команды должны быть введены в корневом каталоге gStore, а имя вашей базы данных не должно заканчиваться на «.db».

Расширенная помощь

Если вы хотите понять детали системы gStore или попробовать некоторые расширенные операции (например, использование API, сервера/клиента), пожалуйста, обратитесь к следующим главам:

• Базовое введение: введение теории и особенностей gStore;
• Руководство по установке: инструкции по установке этой системы;
• Как использовать: подробная информация об использовании системы gStore;
• Объяснение API: поможет вам разрабатывать приложения на основе нашего API;
• Структура проекта: показывает всю структуру и процесс этого проекта;
• Связанные эссе: содержат эссе и публикации, связанные с gStore;
• Журналы обновлений: хранят журналы обновлений системы;
• Результаты тестов: представляют результаты тестов серии экспериментов.

Другие вопросы

Ошибки записываются в BUG REPORT (docs/BUGS.md). Вы можете отправить обнаруженные вами ошибки, если их нет в этом файле.

Нами написана серия коротких эссе, посвящённых... Повторяющиеся проблемы при использовании gStore для реализации приложений, которые размещены в Recipe Book (docs/TIPS.md).

Вы можете сообщить о любых советах или ошибках в разделе github Issues этого репозитория, если не требуется срочный ответ. Однако, если вы хотите, чтобы мы срочно занялись вашими отчётами, отправьте свои предложения и сообщения об ошибках по электронной почте gjsjdbgroup@pku.edu.cn. Полный список всей нашей команды находится в Mailing List (docs/MAIL.md).

Существуют некоторые ограничения при использовании текущего проекта gStore, вы можете увидеть их в Limit Description (docs/LIMIT.md).

Иногда вы можете столкнуться со странными явлениями (но не ошибочными случаями) или с чем-то трудным для понимания/решения (не знаете, что делать дальше), тогда не стесняйтесь посетить страницу Frequently Asked Questions (docs/FAQ.md).

Графовая база данных — это новая область, и мы всё ещё пытаемся развиваться дальше. То, что мы планируем сделать дальше, описано в главе Future Plan (docs/PLAN.md), и мы надеемся, что всё больше людей будут поддерживать нас или даже присоединятся к нам. Вы можете поддержать нас разными способами:

• следить за нашим проектом;
• отметить наш проект звёздочкой;
• разветвить этот репозиторий и отправить нам запросы на включение изменений;
• загрузить и использовать эту систему, сообщать об ошибках или предложениях;
• ...

Люди, которые вдохновляют нас или вносят вклад в этот проект, будут перечислены в главе Thanks List (docs/THANK.md).