百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
E

entimport

> 编程语言
开源

用于从 SQL 结构生成 Ent 结构的工具

200 stars0 点赞1 次浏览
访问官网GitHub

工具介绍

用于从 SQL 结构生成 Ent 结构的工具

entimport

entimport is a tool for creating Ent schemas from existing SQL databases. Currently, MySQL and PostgreSQL are supported. The tool can import to ent schema any number of tables, including relations between them.

Installation

Setup A Go Environment

If your project directory is outside GOPATH or you are not familiar with GOPATH, setup a Go module project as follows:

bash
go mod init 

Install ent

bash
go install entgo.io/ent/cmd/ent

After installing ent codegen tool, you should have it in your PATH. If you don't find it your path, you can also run: go run entgo.io/ent/cmd/ent

Create Schema Directory

Go to the root directory of your project, and run:

bash
ent init

The command above will create /ent/schema/ directory and the file inside /ent/generate.go

Importing a Schema

Installing and running entimport

bash
go run ariga.io/entimport/cmd/entimport
  • For example, importing a MySQL schema with users table:
bash
go run ariga.io/entimport/cmd/entimport -dsn "mysql://root:pass@tcp(localhost:3308)/test" -tables "users"

The command above will write a valid ent schema into the directory specified (or the default ./ent/schema):

.
├── generate.go
└── schema
    └── user.go

1 directory, 2 files

Code Generation:

In order to generate ent files from the produced schemas, run:

bash
go run -mod=mod entgo.io/ent/cmd/ent generate ./schema

# OR `ent` init:

go generate ./ent

If you are not yet familiar with ent, you can also follow the quick start guide.

Usage

bash
entimport  -h
Usage of ./entimport:
  -dsn string
        data source name (connection information), for example:
        "mysql://user:pass@tcp(localhost:3306)/dbname"
        "postgres://user:pass@host:port/dbname"
  -schema-path string
        output path for ent schema (default "./ent/schema")
  -tables value
        comma-separated list of tables to inspect (all if empty)

Examples:

  1. Import ent schema from Postgres database

Note: add search_path=foo if you use non public schema.

bash
go run ariga.io/entimport/cmd/entimport -dsn "postgres://postgres:pass@localhost:5432/test?sslmode=disable" 
  1. Import ent schema from MySQL database
bash
go run ariga.io/entimport/cmd/entimport -dsn "mysql://root:pass@tcp(localhost:3308)/test"
  1. Import only specific tables:

Note: When importing specific tables:
if the table is a join table, you must also provide referenced tables.
If the table is only one part of a relation, the other part won't be imported unless specified.
If the -tables flags is omitted all tables in current database schema will be imported

bash
go run ariga.io/entimport/cmd/entimport -dsn "..." -tables "users,user_friends" 
  1. Import to another directory:
bash
go run ariga.io/entimport/cmd/entimport -dsn "..." -schema-path "/some/path/here"

Future Work

  • Index support (currently Unique index is supported).
  • Support for all data types (for example uuid in Postgres).
  • Support for Default value in columns.
  • Support for editing schema both manually and automatically (real upsert and not only overwrite)
  • Postgres special types: postgres.NetworkType, postgres.BitType, *schema.SpatialType, postgres.CurrencyType, postgres.XMLType, postgres.ArrayType, postgres.UserDefinedType.

Known Caveats:

  • Schema files are overwritten by new calls to entimport.
  • There is no difference in DB schema between O2O Bidirectional and O2O Same Type - both will result in the same ent schema.
  • There is no difference in DB schema between M2M Bidirectional and M2M Same Type - both will result in the same ent schema.
  • In recursive relations the edge names will be prefixed with child_ & parent_.
  • For example: users with M2M relation to itself will result in:
go
func (User) Edges() []ent.Edge {
return []ent.Edge{edge.To("child_users", User.Type), edge.From("parent_users", User.Type)}
}

Feedback & Support

For discussion and support, open an issue or join our channel in the gophers Slack.

Issues· 21 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Go

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言