Giter VIP home page Giter VIP logo

Comments (4)

kenshaw avatar kenshaw commented on May 30, 2024

I have partial support that is nowhere near completed for PostgreSQL. However, any implementation I would like for multiple databases to be supported. I don't know if Oracle/MSSQL support comments, but I believe MySQL does. Additionally, for SQLite, I'd like to extract comments from the schema if possible (likely using regular expressions or some such).

My original thought was that I was going to use the comments on tables/columns/etc. as a way to hold metadata for schema directives to xo, but realize this may not be elegant/confusing.

I'm more than happy to consider any pull request that is well written, so please send one if you have it.

A quick overview of what would need to be done:
Fields would need to be added to the different template struct types in internal/types.go. It's there that you should add a Comment string member to the struct (if not already defined), and then modify the files in templates/ to support/output those. Additionally, you'll need to modify various database support files in loaders/ to extract the comments for the types. Lastly, you'll need to add the call in xo.go and modify the logic in internal/loader.go to support the changed loader code.

from xo.

stub42 avatar stub42 commented on May 30, 2024

I have two, potentially conflicting, use cases for this.

  1. Specify capitalization, so my alllowercase tablenames and functionnames are correctly CamelCased.
  2. Have the comments inserted as comments, so my database comments propagate to my godoc documentation.

from xo.

olegsu avatar olegsu commented on May 30, 2024

@kenshaw are camel case columns not supported?

from xo.

kenshaw avatar kenshaw commented on May 30, 2024

@olegsu camel case columns should be supported. Is there a reason you're adding this on a very old and closed ticket?

from xo.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.