Создание базы данных и добавление таблиц — Visual Studio (Windows)
Twitter LinkedIn Facebook Адрес электронной почты- Статья
Область применения:
Примечание
Наборы данных и связанные классы — это устаревшие технологии . NET с начала 2000-х годов, которые позволяют приложениям работать с данными в памяти при отключении приложений от базы данных. Они особенно полезны для приложений, которые позволяют пользователям изменять данные и сохранять изменения обратно в базу данных. Несмотря на то, что наборы данных оказались очень успешной технологией, мы рекомендуем использовать Entity Framework Core в новых приложениях .NET. Платформа Entity Framework предоставляет более естественный способ работы с табличными данными в виде объектных моделей и имеет более простой программный интерфейс.
Visual Studio можно использовать для создания и обновления файла локальной базы данных в SQL Server Express LocalDB. Вы также можете создать базу данных, выполнив инструкции Transact-SQL в окне инструментов SQL Server обозреватель объектов
в Visual Studio. В этом разделе описано, как создать MDF-файл и добавить таблицы и ключи с помощью конструктора таблиц.Предварительные требования
Чтобы выполнить это пошаговое руководство, вам потребуется рабочие нагрузки разработка классических приложений . NET и хранение и обработка данных , установленные в Visual Studio. Чтобы установить их, откройте Visual Studio Installer и выберите Изменить (или Дополнительно>изменить) рядом с версией Visual Studio, которую вы хотите изменить.
Примечание
Процедуры, описанные в этой статье, применяются только к платформа .NET Framework Windows Forms проектам, а не к проектам .NET Core Windows Forms.
Создание проекта и файла локальной базы данных
Создайте новый проект приложения Windows Forms (платформа .NET Framework) и назовите его SampleDatabaseWalkthrough.
В строке меню выберите Проект>Добавить новый элемент. Если отображается небольшое диалоговое окно с полем для имени файла, выберите Показать все шаблоны.
В списке шаблонов элементов прокрутите вниз и выберите База данных на основе служб.
Присвойте базе данных имя SampleDatabase.mdf и нажмите кнопку Добавить.
Добавление источника данных
Если окно Источники данных не открыто, откройте его, нажав клавиши SHIFT
В окне Источники данных выберите Добавить новый источник данных.
Откроется мастер настройки источника данных .
На странице Выбор типа источника данных выберите База данных , а затем нажмите кнопку Далее.
На странице Выбор модели базы данных нажмите кнопку Далее , чтобы принять значение по умолчанию (набор данных).
На странице Выбор подключения к данным выберите файл SampleDatabase.mdf в раскрывающемся списке и нажмите кнопку Далее.
На странице Сохранение строки подключения в файле конфигурации приложения нажмите кнопку Далее.
На странице Выбор объектов базы данных появится сообщение о том, что база данных не содержит объектов. Нажмите кнопку Готово.
Просмотр свойств подключения к данным
Строку подключения для файла SampleDatabase.mdf можно просмотреть, открыв окно свойств подключения к данным:
Выберите Вид>SQL Server обозреватель объектов чтобы открыть окно SQL Server обозреватель объектов. Разверните узел (localdb)\Базы данных MSSQLLocalDB>, а затем щелкните правой кнопкой мыши SampleDatabase.mdf (он может быть указан как полный путь) и выберите Свойства.
Кроме того, можно выбрать Просмотр
Совет
Если не удается развернуть узел Подключения к данным или подключение SampleDatabase.mdf отсутствует в списке, нажмите кнопку Подключиться к базе данных на панели Обозреватель сервера. В диалоговом окне Добавление подключения убедитесь, что в разделе Источник данных выбран файл базы данных Microsoft SQL Server, а затем перейдите к файлу SampleDatabase.mdf и выберите его. Завершите добавление подключения, нажав кнопку ОК.
В этом разделе вы создадите две таблицы, первичный ключ в каждой таблице и несколько строк примеров данных. Вы также создаете внешний ключ, чтобы указать, как записи в одной таблице соответствуют записям в другой таблице.
Создание таблицы Customers
В разделе Server Обозреватель или SQL Server Object Browser разверните узел Подключения к данным, а затем узел SampleDatabase.mdf.
Щелкните правой кнопкой мыши Таблицы и выберите Добавить новую таблицу.
Будет открыт Конструктор таблиц, отобразится сетка с одной строкой по умолчанию, которая представляет один столбец в создаваемой таблице. Добавляя строки в сетку, вы добавляете столбцы в таблицу.
В сетке добавьте строку для каждой из следующих записей.
Имя столбца Тип данных Разрешить значения null CustomerID
nchar(5)
False (не установлен) CompanyName
nvarchar(50)False (не установлен) ContactName
nvarchar (50)
True (установлен) Phone
nvarchar (24)
True (установлен) Щелкните строку правой
CustomerID
кнопкой мыши и выберите пункт Задать первичный ключ.Щелкните правой кнопкой мыши строку по умолчанию (
Id
) и выберите удалить.Назовите таблицу «Клиенты» путем обновления первой строки в области скриптов, как показано в следующем примере:
CREATE TABLE [dbo].[Customers]
Добавьте ограничение индекса в таблицу Customers. Добавьте запятую в конце
Phone
строки, а затем добавьте следующий пример перед закрывающей скобкой:CONSTRAINT [PK_Customers] PRIMARY KEY ([CustomerID])
Отобразятся примерно следующие сведения:
В левом верхнем углу конструктора таблиц выберите Обновить или нажмите клавиши SHIFT+ALT+U.
В диалоговом окне Предварительный просмотр базы данных Обновления выберите Обновить базу данных.
Таблица Customers создается в файле локальной базы данных.
Создание таблицы Orders
Создайте еще одну таблицу, а затем добавьте строку для каждой записи следующей таблицы.
Имя столбца Тип данных Разрешить значения null OrderID
int
False (не установлен) CustomerID
nchar(5)
False (не установлен) OrderDate
datetime
True (установлен) OrderQuantity
int
True (установлен) Задайте OrderID в качестве первичного ключа, а затем удалите строку по умолчанию.
Назовите таблицу «Заказы» путем обновления первой строки в области скриптов, как показано в следующем примере:
CREATE TABLE [dbo].[Orders]
Добавьте ограничение индекса в таблицу Customers. Добавьте запятую в конце
OrderQuantity
строки, а затем добавьте следующий пример перед закрывающей скобкой:CONSTRAINT [PK_Orders] PRIMARY KEY ([OrderId])
В левом верхнем углу конструктора таблиц выберите Обновить или нажмите клавиши SHIFT+ALT+U..
В диалоговом окне Предварительный просмотр базы данных Обновления выберите Обновить базу данных.
Таблица Orders создается в файле локальной базы данных. Если развернуть узел Таблицы в серверной Обозреватель, вы увидите две таблицы:
Если вы не видите его, нажмите кнопку Обновить на панели инструментов.
Создание внешнего ключа
В контекстной области в правой части сетки конструктора таблиц таблицы Orders щелкните правой кнопкой мыши элемент Внешние ключи и выберите Добавить новый внешний ключ.
В появившемся текстовом поле замените текст
На панели T-SQL обновите последнюю строку в соответствии со следующим примером:
CONSTRAINT [FK_Orders_Customers] FOREIGN KEY ([CustomerID]) REFERENCES [Customers]([CustomerID])
В левом верхнем углу конструктора таблиц выберите Обновить (SHIFT+ALT+U).
В диалоговом окне Предварительная версия Обновления базы данных выберите Обновить базу данных.
Создается внешний ключ.
Заполнение таблиц данными
В Обозреватель сервера или SQL Server обозреватель объектов разверните узел для примера базы данных.
Откройте контекстное меню для узла Таблицы , выберите Обновить, а затем разверните узел Таблицы .
Откройте контекстное меню для таблицы Customers и выберите Показать данные таблицы или Просмотреть данные.
Добавьте нужные данные для некоторых клиентов.
Можно указать любые пять символов как ИД клиентов, но хотя бы один нужно выбрать и запомнить для дальнейшего использования в этой процедуре.
Откройте контекстное меню таблицы Orders и выберите Показать данные таблицы или Просмотреть данные.
Добавление данных для некоторых заказов. По мере ввода каждой строки она сохраняется в базе данных.
Важно!
Убедитесь, что все идентификаторы заказов и количества заказов — целые числа, и каждый идентификатор клиента соответствует значению, указанному в столбце CustomerID таблицы клиентов.
Поздравляем! Теперь вы знаете, как создавать таблицы, связывать их с помощью внешнего ключа и добавлять данные.
См. также раздел
- Доступ к данным в Visual Studio
Как мы нашли С++ для компании-разработчика баз данных
- Клиент: международная компания, разрабатывающая базы данных
- Вакансия: Разработчик C++
- Руководитель проекта: Альбина Абрамова
Опытные разработчики, работающие с базами данных, — достаточно редкие кандидаты. Они востребованы у крупных работодателей или в компаниях, работающих именно над созданием БД. Заказчики же обычно ждут от таких соискателей серьезной математической подготовки. И если найти просто сильного программиста задача сложная, но вполне решаемая, то найти специалиста по БД, обладающего глубокими знаниями математики, статистики подобрать гораздо сложнее. Недавно мы нашли разработчика C++ в молодую, но уверенно набирающую обороты иностранную компанию. Рассказываем подробности.
Клиент
К нам обратилась международная компания, развивающая крупный Open Source проект, уникальность которого заключается в создании NoSQL базы данных, объединяющей три модели данных: графовую, документную и модель «ключ-значение». Команда, находящаяся в России, занимается разработкой поискового движка. А представительства работодателя расположены в нескольких странах. Проект постоянно увеличивается и модернизируется, количество и масштаб задач растет, поэтому компания приняла решение усилить московский офис опытными специалистами, которые бы приняли активное участие в разработке высоконагруженного распределенного поискового движка в составе NoSQL базы данных с использованием modern C++ (14, 17).
Требования к разработчику C++
Заказчик был заинтересован в технически сильном кандидате с опытом коммерческой разработки на C++, отличным знанием алгоритмов и структур данных. А т.к. предстояло работать в команде, разрабатывающей движок базы данных, то опыт работы с RocksDB, или опыт работы с поисковыми движками, например, ElasticSearch, Solr, Sphinx, был бы огромным плюсом. К тому же большое значение имели soft skills: соискателю предстояло влиться в небольшой коллектив, и было важно, чтобы его интересы и ценности совпадали с существующими в команде.
Сложности поиска опытного разработчика C++
Альбина Абрамова, рекрутер GlobalCareer: «Данная вакансия была интересна кандидатам — международная компания, востребованный продукт, сильная команда, возможность серьезно прокачать экспертизу. Но часть специалистов с недоверием отнеслась к тому, что заказчик предусматривал оформление не по трудовому договору. Компания предлагала сотрудничество по договору подряда с физическим лицом, или по договору с индивидуальным предпринимателем. Для российских разработчиков ситуации трудоустройства подобного типа более редкие (в отличие от консультантов SAP, например), и они могут относиться к этим вариантам настороженно. Поэтому консультации работодателя и поддержка на всех этапах оформления ИП были критично важны для всех соискателей».
Также часть возражений была связана с отсутствием привычного социального пакета. Работа с зарубежными компаниями предполагает определенную смену ракурса: у специалиста появляется возможность окунуться в новую корпоративную культуру, сменить рабочие сценарии, попробовать иной подход к трудоустройству. Часто в таких организациях нет привычного набора льгот, другой тип занятости, рабочий график. На первый взгляд, это может пугать соискателей: внутри российского рынка, все устроено привычно и примерно одинаково, но при детальном анализе становится ясно, что предложения иностранных работодателей привлекательны. Так, при подробном обсуждении данной вакансии кандидатам становились очевидны плюсы: зарплата в евро, возможность присоединиться к перспективной международной компании практически на старте и работа над востребованным продуктом, когда он находится на стадии роста.
Кандидат, принявший оффер
Специалист, получивший предложение о работе, был найден в первые же дни поисков. У него отличное техническое образование, а также он долгое время работал в качестве SDET в команде тестирования в иностранной компании, занимающейся автоматизацией проектирования электроники для электротехники и электроники. Кандидат хорошо разбирается в алгоритмах, во время учебы в университете активно участвовал в олимпиадах по программированию, прекрасно знает C/C++, Python и заинтересован прокачивать свои hard skills и дальше. Помимо технического бэкграунда, работодателю понравились коммуникативные навыки соискателя.
Сейчас мы занимаемся поиском ещё нескольких специалистов в данную команду — если хотите работать над разработкой NoSQL базы данных, присылайте своё резюме.
А если вам нужны IT-специалисты, оставляйте заявку, и мы найдем подходящих кандидатов.
микросервисов — База данных «C:/data/sample» не найдена, а IFEXISTS = true, поэтому мы не можем создать ее автоматически — Ошибка в Spring Boot
спросил
Изменено 8 месяцев назад
Просмотрено 25 тысяч раз
Я создал приложение весенней загрузки для подключения к нему базы данных h3. При этом выдает ошибку, указывающую, что база данных не найдена. Пожалуйста, помогите мне с решением, которое я могу реализовать и решить проблему.
Я добавил зависимость com.h3database в файл pom.xml, но также выдает ошибку.
Ниже мой файл pom.xml и файл application.properties
pom.xml
4.0.0 <родительский>org.springframework.boot spring-boot-starter-parent <версия>2.1.4.РЕЛИЗверсия>родительский> com.example santanderdbproj <версия>0.0.1-SNAPSHOTверсия>первый проект Демонстрационный проект для Spring Boot <свойства>версия>1.8 3.1.1 свойства> <зависимости> <зависимость>org.springframework.boot весенняя загрузка-стартер зависимость> <зависимость>org.springframework.boot spring-boot-starter-web зависимость> <зависимость>org.springframework.boot весенний-загрузочный-стартер-тест тест зависимость> <зависимость>база данных com.h3 h3 среда выполнения зависимость> зависимости> <сборка> <плагины> <плагин>org.springframework.boot spring-boot-maven-плагин плагин> плагины> сборка> <репозитории> <репозиторий>весенние вехи Вехи весны https://repo. spring.io/milestone репозиторий> <репозиторий>весенние снимки Весенние снимки https://repo.spring.io/snapshot <снимки>true моментальные снимки> репозиторий> репозитории> <репозиторий плагинов> <репозиторий плагинов>весенние вехи Вехи весны https://repo.spring.io/milestone <репозиторий плагинов>весенние снимки Весенние снимки https://repo.spring.io/snapshot <снимки>true моментальные снимки> проект>
application.properties
spring.datasource.url = jdbc:h3:file:C:/data/sample spring.datasource.driverClassName=org.h3.Драйвер spring.datasource.username=sa весна.источник данных.пароль= spring. jpa.database-platform = org.hibernate.dialect.h3Dialect spring.h3.console.enabled = правда весна.h3.console.path=/h3
Я прикрепил изображение ошибки ниже, пожалуйста, обратитесь к нему.
- spring-boot
- микросервисы
- pom.xml
- h3
- приложение.свойства
Это неверное сообщение об ошибке, которое появляется только в версиях 1.4.198 и 1.4.199. В следующей версии h3 (1.4.200) сообщение будет отображаться лучше, например
.База данных… не найдена, либо создайте ее заранее, либо разрешите создание удаленной базы данных (не рекомендуется в безопасных средах)
Вы видите это сообщение об ошибке, потому что ваша база данных еще не существует. Обычный способ решить вашу проблему — сначала создать базу данных с вашим приложением, прежде чем пытаться войти в нее с помощью консоли h3.
h3 Консоль может быть настроена на создание базы данных, но это может создать брешь в безопасности вашей системы, любой, кто может открыть эту страницу, может делать что угодно с вашей системой с вашими правами доступа в такой конфигурации.
Обратите внимание, что консоль h3 в сеансе браузера запускается h3 с его значка на панели задач (вы можете просто запустить h3-1.4.199 jar как приложение Java или использовать java -jar h3-1.4.199.jar
) дает вам разрешение на создание новой базы данных безопасным способом. Вы можете использовать его для этой цели. Если вы не планируете использовать его в качестве TCP-сервера, закройте его с помощью значка на панели задач после создания базы данных, чтобы убедиться, что он не содержит вашу базу данных. Вы также можете использовать инструмент оболочки командной строки:
https://h3database.com/html/tutorial.html#creating_new_databases
h3 Консоль Spring не поставляется с такой функцией.
Старые версии h3 (до 1.4.197) также позволяют создавать базы данных, включая консоль от Spring, но, опять же, это создает дыру в безопасности вашей системы.
В соответствии с базой данных h3 Если ошибка ниже, то у нас есть решение
Сначала перейдите в консоль и найдите URL-адрес jdbc
Скопируйте URL-адрес и поместите его в консоль h3 внутри URL-адреса JDBC.
Затем подключите
!! Удачного кодирования !!
0Возможно, вы пропустили указание версии, добавьте эту зависимость в свой pom.xml это будет работать
<зависимость>база данных com.h3 h3 <версия>1.4.193версия> зависимость>
, если описанный выше шаг не решает проблему, попробуйте изменить URL-адрес JDBC в консоли на следующий URL-адрес
jdbc:h3:mem:testdb0
Добавление версии db, как показано ниже, к зависимости maven, решило проблему для меня.
<версия>1.4.193версия>
У меня сработало переопределение версии для зависимости базы данных h3
<зависимость>база данных com.h3 h3 среда выполнения <версия>1.4.193версия> зависимость>
Мы хотели перейти с 1.4.193 на 1.4.200, поэтому установка версии 1. 4.193 не была для нас правильным решением. Мы дополнительно запускаем TCP-сервер в нашем процессе, поэтому я прочитал ссылку из принятого ответа: https://h3database.com/html/tutorial.html#creating_new_databases
Как было предложено (на самом деле, не предлагается по соображениям безопасности, но мы приняли на себя риск), я добавил аргумент -ifNotExists
к вызову Server.createTcpServer(...)
, и проблема была решена для нас.
а) Попробуйте указать spring.datasource.url=jdbc:h3:mem:testdb — в application.properties б) Убедитесь, что вы используете jdbc:h3:mem:testdb в качестве URL-адреса базы данных в консоли h3
Вы можете добавить конфигурацию базы данных в свой файл свойств.
сервер: порт: 9092 весна: h3: консоль: включено: правда источник данных: URL-адрес: jdbc:h3:mem:testdb; имя пользователя: са пароль: имя-класса-драйвера: org.h3.Driver платформа: h3
Простое добавление версии, как указано в приведенном выше ответе, не помогло мне вместе с версией h3, которую я также добавил ниже, чтобы решить проблему
я добавил ниже версию для зависимостей h3 в pom. xml
<зависимость>база данных com.h3 h3 <версия>1.4.193версия> зависимость>
И добавлена ниже конфигурация в файл application.properties
spring.h3.console.enabled = true весна.источник данных.платформа=h3 spring.datasource.driverClassName = org.h3.Driver spring.datasource.url=jdbc:h3:файл:~/тест; spring.datasource.username=sa весна.источник данных.пароль=
Просто альтернатива , вы также можете получить правильный URL-адрес JDBC в журналах . Пример ЖУРНАЛОВ o.s.b.a.h3.h3ConsoleAutoConfiguration: консоль h3 доступна в «/h3-console». База данных доступна по адресу ‘jdbc:h3:mem:testDb’
Примечание : Чтобы включить журналы h3, добавьте ниже в файл application.properties
spring.h3.console.enabled=true
После посещения localhost:8080/h3-console проверьте URL-адрес. Как правило, он предварительно заполнен. Я удалил его и ввел тот же URL-адрес, что и в файле application.properties.
spring.datasource.url=jdbc:h3:mem:testdb
Кроме того, добавление версии к зависимости h3 в файле pom.xml может быть полезным.
Следуйте приведенным здесь инструкциям, и все готово.
Похоже, что все пытаются по-своему, но решение проблемы не в конфигурации, а в ФИЗИЧЕСКОЙ.
Каким-то образом, если вы хотите подключиться через консоль, Spring не может создать ФИЗИЧЕСКИЙ файл testdb.mv.db в корневой папке, то есть C:/USERS/testdb.mv.db. Я пошел в C:/Users/SHEKHAR и создал текстовый файл New> (не сохраняйте его, пока не переименуете его в testdb.mv.db или test.mv.db. Перезапустите Springboot, «Test Connection» зеленый и Connect , открывает графический интерфейс консоли.
Зарегистрируйтесь или войдите в систему
Зарегистрируйтесь с помощью Google Зарегистрироваться через Facebook Зарегистрируйтесь, используя электронную почту и парольОпубликовать как гость
Электронная почтаОбязательно, но не отображается
Опубликовать как гость
Электронная почтаТребуется, но не отображается
Нажимая «Опубликовать свой ответ», вы соглашаетесь с нашими условиями обслуживания и подтверждаете, что прочитали и поняли нашу политику конфиденциальности и кодекс поведения.
Создание баз данных CodeQL — GitHub Docs
Вы можете создать базу данных CodeQL, содержащую данные, необходимые для запроса вашего кода.
GitHub CodeQL лицензируется для каждого пользователя при установке. Вы можете использовать CodeQL только для определенных задач в соответствии с лицензионными ограничениями. Дополнительные сведения см. в разделе «О интерфейсе командной строки CodeQL».
Если у вас есть лицензия GitHub Advanced Security, вы можете использовать CodeQL для автоматического анализа, непрерывной интеграции и непрерывной доставки. Дополнительные сведения см. в разделе «О GitHub Advanced Security».
Примечание: Эта статья была перенесена с веб-сайта документации CodeQL в январе 2023 года.
Прежде чем анализировать код с помощью CodeQL, необходимо создать базу данных CodeQL, содержащую все данные, необходимые для выполнения запросов к вашему коду. Вы можете создавать базы данных CodeQL самостоятельно с помощью интерфейса командной строки CodeQL или загружать их с GitHub.com.
Анализ CodeQL основан на извлечении реляционных данных из вашего кода и использовании их для создания базы данных CodeQL. Базы данных CodeQL содержат всю важную информацию о кодовой базе, которую можно проанализировать, выполнив к ней запросы CodeQL. GitHub создает и хранит базы данных CodeQL для большого количества проектов с открытым исходным кодом. Дополнительные сведения см. в разделе «Загрузка баз данных CodeQL с GitHub.com».
Вы также можете самостоятельно создавать базы данных CodeQL с помощью интерфейса командной строки CodeQL. Перед созданием базы данных CodeQL необходимо:
- Установить и настроить интерфейс командной строки CodeQL. Дополнительные сведения см. в разделе «Начало работы с интерфейсом командной строки CodeQL».
- Проверьте версию вашей кодовой базы, которую вы хотите проанализировать. Каталог должен быть готов к сборке со всеми установленными зависимостями.
Сведения об использовании интерфейса командной строки CodeQL в сторонней системе непрерывной интеграции для создания результатов, отображаемых в GitHub в качестве предупреждений о сканировании кода, см. в разделе Настройка интерфейса командной строки CodeQL в вашей системе непрерывной интеграции. Сведения о включении сканирования кода CodeQL с помощью действий GitHub см. в разделе Настройка сканирования кода для репозитория.
Базы данных CodeQL создаются с помощью выполнения следующей команды из корня проверки вашего проекта:
база данных codeql create--language=
Необходимо указать:
-
<база данных>
: путь к новой создаваемой базе данных. Этот каталог будет создан при выполнении команды — вы не можете указать существующий каталог. -
--language
: идентификатор языка, для которого создается база данных. При использовании с--db-cluster
, параметр принимает список, разделенный запятыми, или может быть указан более одного раза. CodeQL поддерживает создание баз данных для следующих языков: .
Язык | Идентификатор | |
---|---|---|
C/C++ | cpp | 902 Java/Kotlin ява |
JavaScript/TypeScript | JavaScript | |
Python | Python | 9022 5|
Рубин | Рубин | |
Свифт | Свифт |
Примечание : Анализ CodeQL для Kotlin и Swift в настоящее время находится в стадии бета-тестирования. Во время бета-тестирования анализ кода Kotlin и Swift и сопутствующая документация не будут такими исчерпывающими, как для других языков. Кроме того, Swift 5.8 еще не поддерживается.
Вы можете указать дополнительные параметры в зависимости от расположения вашего исходного файла, если код необходимо скомпилировать, и если вы хотите создать базы данных CodeQL для более чем одного языка:
-
--source-root
: корневая папка для основных исходных файлов, используемых при создании базы данных. По умолчанию команда предполагает, что текущий каталог является исходным корнем — используйте этот параметр, чтобы указать другое местоположение. -
--db-cluster
: используйте для многоязычных кодовых баз, когда вы хотите создать базы данных для более чем одного языка. -
--command
: используется при создании базы данных для одного или нескольких скомпилированных языков, пропустите, если требуются только языки Python и JavaScript. Это указывает команды сборки, необходимые для вызова компилятора. Команды запускаются из текущей папки или--source-root
, если указано. Если вы не укажете--command
, CodeQL попытается автоматически определить систему сборки, используя встроенный автосборщик. -
--no-run-ненужные-сборки
: используется с--db-cluster
для подавления команды сборки для языков, где CLI CodeQL не нужно отслеживать сборку (например, Python и JavaScript/TypeScript).
Можно указать параметры экстрактора, чтобы настроить поведение экстракторов, создающих базы данных CodeQL. Для получения дополнительной информации см. «Параметры экстрактора».
Подробную информацию обо всех параметрах, которые можно использовать при создании баз данных, см. в разделе «Создание базы данных».
Сообщается об ошибках, если возникают какие-либо проблемы с указанными вами параметрами. Для интерпретируемых языков ход извлечения отображается в консоли — для каждого исходного файла сообщается, было ли извлечение успешным или нет. Для скомпилированных языков консоль будет отображать вывод системы сборки.
Когда база данных будет успешно создана, вы найдете новый каталог по пути, указанному в команде. Если вы использовали параметр --db-cluster
для создания более одной базы данных, для каждого языка создается подкаталог. Каждый каталог базы данных CodeQL содержит ряд подкаталогов, включая реляционные данные (необходимые для анализа) и исходный архив — копию исходных файлов, сделанную во время создания базы данных, — которая используется для отображения результатов анализа.
Интерфейс командной строки CodeQL включает экстракторы для создания баз данных для некомпилируемых языков, в частности для JavaScript (и TypeScript), Python и Ruby. Эти экстракторы автоматически вызываются, когда вы указываете JavaScript, Python или Ruby в качестве параметра --language
при выполнении database create
. При создании баз данных для этих языков необходимо обеспечить наличие всех дополнительных зависимостей.
Примечание: При запуске базы данных создайте
для JavaScript, TypeScript, Python и Ruby не следует указывать параметр --command
. В противном случае это переопределяет обычный вызов экстрактора, который создаст пустую базу данных. Если вы создаете базы данных для нескольких языков, и один из них является компилируемым, используйте параметр --no-run-unnecessary-builds
, чтобы пропустить команду для языков, которые не нужно компилировать.
JavaScript и TypeScript
Создание баз данных для JavaScript не требует дополнительных зависимостей, но если проект включает файлы TypeScript, необходимо установить Node. js 6.x или более позднюю версию. В командной строке можно указать --language=javascript
для извлечения файлов JavaScript и TypeScript:
база данных codeql create --language=javascript --source-root <папка для извлечения> <выходная папка>/javascript-database
Здесь мы указали путь --source-root
, который является местом, где выполняется создание базы данных, но не обязательно является корневым каталогом базы кода.
По умолчанию файлы в node_modules
и bower_components
каталоги не извлекаются.
Python
При создании баз данных для Python необходимо убедиться, что:
- У вас установлен Python 3 и он доступен для экстрактора CodeQL.
- У вас установлена версия Python, используемая вашим кодом.
- У вас есть доступ к системе управления пакетами pip, и вы можете устанавливать любые пакеты, от которых зависит кодовая база.
- Вы установили модуль pip virtualenv.
В командной строке необходимо указать --language=python
. Например:
база данных codeql create --language=python/python-database
Это выполняет подкоманду database create
из корня проверки кода, создавая новую базу данных Python по адресу
.
Ruby
Создание баз данных для Ruby не требует дополнительных зависимостей. В командной строке необходимо указать --language=ruby
. Например:
база данных codeql create --language=ruby --source-root <папка для извлечения> <выходная папка>/ruby-database
Здесь мы указали путь --source-root
, который является местом, где выполняется создание базы данных, но не обязательно является корневым каталогом базы кода.
Для скомпилированных языков CodeQL необходимо вызвать требуемую систему сборки для создания базы данных, поэтому метод сборки должен быть доступен для CLI.
Обнаружение системы сборки
Примечание. Анализ CodeQL для Kotlin и Swift в настоящее время находится в стадии бета-тестирования. Во время бета-тестирования анализ кода Kotlin и Swift и сопутствующая документация не будут такими исчерпывающими, как для других языков. Кроме того, Swift 5.8 еще не поддерживается.
Интерфейс командной строки CodeQL включает автосборщики для кода C/C++, C#, Go, Java и Swift. Автосборщики CodeQL позволяют создавать проекты для скомпилированных языков без указания каких-либо команд сборки. Когда вызывается автосборщик, CodeQL проверяет источник на наличие системы сборки и пытается запустить оптимальный набор команд, необходимых для извлечения базы данных.
Автосборщик вызывается автоматически при выполнении базы данных codeql create
для скомпилированного --language
, если не включать --опция команды
. Например, для кодовой базы Java вы просто запустите:
база данных codeql create --language=java/java-database
Если кодовая база использует стандартную систему сборки, использование автосборщика часто является самым простым способом создания базы данных. Для источников, требующих нестандартных шагов сборки, вам может потребоваться явно определить каждый шаг в командной строке.
Примечания:
Если вы создаете базу данных Go, установите цепочку инструментов Go (версия 1.11 или более поздняя) и, если есть зависимости, соответствующий менеджер зависимостей (например, dep).
Автосборщик Go пытается автоматически обнаружить код, написанный на Go, в репозитории и запускает скрипты сборки только для получения зависимостей. Чтобы заставить CodeQL ограничить извлечение файлами, скомпилированными вашим скриптом сборки, установите переменную среды
CODEQL_EXTRACTOR_GO_BUILD_TRACING=on
или используйте параметр--command
, чтобы указать команду сборки.
Указание команд сборки
Следующие примеры предназначены для того, чтобы дать вам представление о некоторых командах сборки, которые вы можете указать для скомпилированных языков.
Примечание: Параметр --command
принимает один аргумент — если вам нужно использовать более одной команды, укажите --command
несколько раз. Если вам нужно передать подкоманды и параметры, весь аргумент должен быть заключен в кавычки для правильной интерпретации.
Проект C/C++, созданный с использованием
make
:база данных codeql создает базу данных cpp --language=cpp --command=make
Проект C#, созданный с использованием
dotnet build
:Рекомендуется добавить
/t:rebuild
, чтобы убедиться, что весь код будет собран, или сделать предыдущуюочистку dotnet
(код, который не создан, не будет включен в базу данных CodeQL):база данных codeql создает базу данных csharp --language=csharp --command='dotnet build /t:rebuild'
Проект Go, созданный с использованием переменной среды
CODEQL_EXTRACTOR_GO_BUILD_TRACING=on
:CODEQL_EXTRACTOR_GO_BUILD_TRACING=в базе данных codeql создать базу данных go --language=go
Проект Go, созданный с использованием пользовательского скрипта сборки:
база данных codeql создает базу данных go --language=go --command='. /scripts/build.sh'
Java-проект, созданный с использованием Gradle:
# Используйте `--no-daemon`, потому что сборка, делегированная существующему демону, не может быть обнаружена CodeQL: база данных codeql создать базу данных java --language=java --command='gradle --no-daemon clean test'
Java-проект, созданный с использованием Maven:
база данных codeql создает базу данных java --language=java --command='mvn clean install'
Проект Java, созданный с использованием Ant:
база данных codeql создает базу данных java --language=java --command='ant -f build.xml'
Проект Swift, созданный из проекта или рабочей области Xcode. По умолчанию создается самая большая цель Swift:
.Рекомендуется убедиться, что проект находится в чистом состоянии и что нет доступных артефактов сборки.
xcodebuild очистить все База данных codeql создать -l swift Swift-база данных
Проект Swift, созданный с помощью
swift build
:база данных codeql create -l swift -c "быстрая сборка" swift-database
Проект Swift, созданный с помощью
xcodebuild
:база данных codeql create -l swift -c "xcodebuild build -target your-target" swift-database
Можно пройти
архив
итест
вариантов доxcodebuild
. Однако рекомендуется стандартная командаxcodebuild
, так как она должна быть самой быстрой и должна быть всем, что требуется CodeQL для успешного сканирования.Проект Swift, созданный с использованием пользовательского скрипта сборки:
база данных codeql create -l swift -c "./scripts/build.sh" swift-база данных
Проект построен на Базеле:
# Перейдите в рабочую область Bazel. # Перед сборкой удалить кешированные объекты # и остановите все запущенные процессы сервера Bazel. Базель очистить --expunge # Сборка с использованием следующих флагов Bazel, чтобы помочь CodeQL обнаружить сборку: # `--spawn_strategy=local`: сборка локально, вместо использования распределенной сборки # `--nouse_action_cache`: отключить кеширование сборки, что может помешать перекомпиляции исходного кода # `--noremote_accept_cached`, `--noremote_upload_local_results`: избегать использования удаленного кеша база данных codeql создать новую базу данных --language=<язык> \ --command='bazel build --spawn_strategy=local --nouse_action_cache --noremote_accept_cached --noremote_upload_local_results //путь/к/пакету: цель' # После сборки остановите все запущенные процессы сервера Bazel. # Это гарантирует, что будущие команды сборки будут запускаться в чистом процессе сервера Bazel. # без прикрепленного CodeQL. базель выключение
Проект, созданный с использованием пользовательского скрипта сборки:
база данных codeql создает новую базу данных --language=
--command='./scripts/build.sh'
Эта команда запускает пользовательский сценарий, содержащий все команды, необходимые для сборки проекта.
Использование косвенной трассировки сборки
Если автосборщики CodeQL CLI для скомпилированных языков не работают с вашим рабочим процессом CI и вы не можете обернуть вызовы команд сборки с помощью команда трассировки базы данных codeql
, вы можете использовать непрямую трассировку сборки для создания базы данных CodeQL. Чтобы использовать непрямую трассировку сборки, ваша система непрерывной интеграции должна иметь возможность устанавливать пользовательские переменные среды для каждого действия сборки.
Чтобы создать базу данных CodeQL с непрямой трассировкой сборки, выполните следующую команду из корня проверки вашего проекта:
codeql database init ... --begin-tracing
Необходимо указать:
-
<база данных>
: путь к новой создаваемой базе данных. Этот каталог будет создан при выполнении команды — вы не можете указать существующий каталог. -
--begin-tracing
: создает сценарии, которые можно использовать для настройки среды, в которой будут отслеживаться команды сборки.
Вы можете указать другие параметры для команды codeql database init
, как обычно.
Примечание: Если сборка выполняется в Windows, необходимо установить либо --trace-process-level
или --trace-process-name <имя родительского процесса>
, чтобы параметр указывал на родительский процесс CI, который будет наблюдать за всеми этапами сборки анализируемого кода.
Команда codeql database init
выведет сообщение:
Создан каркас. Эта незавершенная база данных готова к заполнению экстрактором. Чтобы инициализировать трассировку, необходимо установить некоторые переменные среды в оболочке, в которой будет выполняться ваша сборка. Для этого в /temp/tracingEnvironment создан ряд сценариев. Пожалуйста, запустите один из этих скриптов перед вызовом команды сборки. В зависимости от вашей операционной системы мы рекомендуем вам запустить: ...
Команда codeql database init
создает
с файлами, содержащими переменные среды и значения, которые позволят CodeQL отслеживать последовательность шагов сборки. Эти файлы называются start-tracing.{json,sh,bat,ps1}
. Используйте один из этих файлов с механизмом вашей системы CI для установки переменных среды для будущих шагов. Вы можете:
- Прочитать файл JSON, обработать его и распечатать переменные среды в формате, ожидаемом вашей системой CI. Например, Azure DevOps ожидает
эхо "##vso[task.setvariable variable=NAME]VALUE"
. - Или, если ваша система CI сохраняет среду, создайте соответствующий сценарий
start-tracing
, чтобы установить переменные CodeQL в среде оболочки системы CI.
Создайте свой код; при необходимости отключите переменные среды с помощью сценария end-tracing.{json,sh,bat,ps1}
из каталога, где хранятся сценарии start-tracing
; а затем выполните команду база данных codeql завершена
.
Создав базу данных CodeQL с помощью косвенной трассировки сборки, вы можете работать с ней, как с любой другой базой данных CodeQL. Например, проанализируйте базу данных и загрузите результаты на GitHub, если вы используете сканирование кода.
Пример создания базы данных CodeQL с использованием косвенной трассировки сборки
Примечание. Если вы используете конвейеры Azure DevOps, самый простой способ создать базу данных CodeQL — использовать GitHub Advanced Security для Azure DevOps. Документацию см. в статье Настройка расширенной безопасности GitHub для Azure DevOps в Microsoft Learn.
В следующем примере показано, как можно использовать непрямую трассировку сборки в конвейере Azure DevOps для создания базы данных CodeQL:
шагов: # Загрузите интерфейс командной строки CodeQL и пакеты запросов... # Проверить репозиторий... # Запуск любых задач перед сборкой, например, восстановление зависимостей NuGet... # Инициализировать базу данных CodeQL. # В этом примере CLI CodeQL был загружен и помещен в PATH. - задача: CmdLine@1 displayName: Инициализировать базу данных CodeQL входы: # Предполагается, что исходный код извлечен в текущий рабочий каталог. # Создает базу данных в `<текущий рабочий каталог>/db`. # Работает в Windows, поэтому указывает уровень процесса трассировки. script: "инициализация базы данных codeql --language csharp --trace-process-name Agent.Worker.exe --source-root . --begin-tracing db" # Чтение сгенерированных переменных среды и значений, # и установите их так, чтобы они были доступны для последующих команд # в конвейере сборки. В этом примере это делается в PowerShell. - задача: PowerShell@1 displayName: установить переменные среды CodeQL. входы: targetType: встроенный сценарий: > $json = Get-Content $(System.DefaultWorkingDirectory)/db/temp/tracingEnvironment/start-tracing.json | ConvertFrom-Json $json.PSObject.Properties | ForEach-Object { $template = "##vso[task.setvariable variable=" $шаблон += $_.Имя $шаблон += "]" $шаблон += $_.Значение эхо "$шаблон" } # Выполнить предопределенный шаг сборки. Обратите внимание на переменную msbuildArgs. - задача: VSBuild@1 входы: решение: '**/*.sln' msbuildArgs: /p:OutDir=$(Build.ArtifactStagingDirectory) платформа: любой процессор конфигурация: выпуск # Выполните чистую сборку, чтобы удалить все существующие артефакты сборки перед сборкой. чистый: правда displayName: Сборка Visual Studio # Прочитайте и установите сгенерированные переменные среды, чтобы завершить трассировку сборки. В этом примере это делается в PowerShell. - задача: PowerShell@1 displayName: очистить переменные среды CodeQL входы: targetType: встроенный сценарий: > $json = Get-Content $(System.DefaultWorkingDirectory)/db/temp/tracingEnvironment/end-tracing.json | ConvertFrom-Json $json.PSObject.Properties | ForEach-Object { $template = "##vso[task.setvariable variable=" $шаблон += $_.Имя $шаблон += "]" $шаблон += $_.Значение эхо "$шаблон" } - задача: CmdLine@2 displayName: Завершить базу данных CodeQL входы: скрипт: 'база данных codeql финализирует db' # Здесь идут другие задачи, например: # `анализ базы данных codeql` # затем `codeql github upload-results` .