В MySQL (и других базах данных SQL) может быть полезно добавлять комментарии к таблице или столбцу, назначение которых может быть неясным. (Поищите MySQL в синтаксисе создания таблицы для слова "комментарий" для Примеры.)
Есть ли способ сделать это в ActiveRecord Migration? Я пробовал это без каких-либо результатов.
create_table :stuff do |t|
t.integer :obscure_column, :comment => "Explanatory comment"
end
Я использую Рельсы 3.1.
Гем migration_comments, упомянутый в комментарии к исходному вопросу, кажется лучшим решением для кросс-базы данных для этой потребности. . В дополнение к поддержке миграции для добавления комментариев к таблицам и столбцам, гем также аннотирует файл schema.rb, чтобы включить все комментарии. Идеально подходит для нужд моей компании (большое устаревшее приложение rails, в котором модель базы данных неоднозначна и также используется командой аналитиков, пишущих собственные отчеты SQL).
change_column_comment, как объяснено в моем ответе stackoverflow.com/a/60584476/3090068
- person Yuki Inoue; 08.03.2020
В Rails 5 вы можете использовать change_column:
class AddCommentsToReferences < ActiveRecord::Migration[5.2]
def up
change_column :references, :achievement_id, :integer, comment: 'Achievement'
change_column :references, :object_id, :integer, comment: 'Achievement object id'
end
end
не забудьте написать правильный column_type в качестве третьего параметра.
change_column_comment, как объяснено в моем ответе stackoverflow.com/a/60584476/3090068
- person Yuki Inoue; 08.03.2020
Существует гем под названием pg_comment, который добавит эту функциональность, если вы используете postgresql.
Драгоценный камень добавляет дополнительные команды для добавления комментариев. Обратите внимание, что синтаксис в postgresql отличается от синтаксиса в mysql, и я думаю, именно поэтому нет общей реализации ActiveRecord.
Например:
create_table :stuff do |t|
t.integer :some_value
end
set_table_comment :stuff, 'This table stores stuff.'
set_column_comment :stuff, :some_value, 'Stores some value'
Это может стать довольно многословным, но я знаю, что есть несколько хороших инструментов, которые используют это.
Во-вторых, Rails действительно позволяет вам управлять вашей схемой изнутри rails (и это здорово), может показаться достаточным документировать ваши миграции, но через некоторое время никто больше не смотрит на миграции. И вы застряли с недокументированной схемой.
В адаптере oracle-enhanced эта функция доступна с самого начала и имеет тот же синтаксис, что и ты предложил.
К сожалению, я не нашел подобного драгоценного камня или решения для MySQL.
Я не знаю, когда появился этот метод, но в последних версиях рельсов (6.0) вы можете использовать метод change_column_comment.
def change
change_column_comment(:posts, :state, from: "old_comment", to: "new_comment")
end
migration_comments, который сделает то, что вам нужно. Долго не тестировался в бою, но буду рад любым отзывам... - person PinnyM schedule 13.04.2012