You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, generating a table from the basic SQL will strip the field comments completely:
CREATE TABLE test (
id text PRIMARY KEY,
-- Some helpful comment to pass on to the go code
some_field text NOT NULL
)
It would be great if we could write comments in our table description, and have that comment show up in our go code as it gets run. Some fields need more than just a name, and having these would be a really helpful way of reading the code. Most people will read the go struct, not go hunt for the SQL file with the comments themselves.
Happy to open a PR for it if theres interest :)
What database engines need to be changed?
No response
What programming language backends need to be changed?
Go
The text was updated successfully, but these errors were encountered:
For anyone interested: this can be achieved by using comment on
CREATE TABLE authors (
id BIGSERIAL PRIMARY KEY,
name text NOT NULL,
bio text
);
comment on table authors is 'contains authors in the library';
comment on column authors.name is 'name of the author starting with first name';
For anyone interested: this can be achieved by using comment on
CREATE TABLE authors (
id BIGSERIAL PRIMARY KEY,
name text NOT NULL,
bio text
);
comment on table authors is 'contains authors in the library';
comment on column authors.name is 'name of the author starting with first name';
Unfortunately this does not work for sqlite :(
oxisto
added a commit
to oxisto/sqlc
that referenced
this issue
Dec 27, 2024
This is a partial solution for sqlc-dev#3430 for sqlite, which may or may not be adaptable for other engines. It basically looks for single-line comments before the CREATE command and in-between column definitions.
What do you want to change?
Currently, generating a table from the basic SQL will strip the field comments completely:
It would be great if we could write comments in our table description, and have that comment show up in our go code as it gets run. Some fields need more than just a name, and having these would be a really helpful way of reading the code. Most people will read the go struct, not go hunt for the SQL file with the comments themselves.
Happy to open a PR for it if theres interest :)
What database engines need to be changed?
No response
What programming language backends need to be changed?
Go
The text was updated successfully, but these errors were encountered: