arql 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3180e4c8b35e489b880dd97da124ee8f3879ee68407059f9225b6fb25442a752
-  data.tar.gz: 1092f95cfad6cd95cde554771ae1b8c23b43bc30e7de65ed75a06a3af9d59565
+  metadata.gz: dfa69341937ac1de34d54c8d3506759fd4979d59cc4d52333726cd8ba04fb346
+  data.tar.gz: 4e65c0ea33d4c45c52e166839fdd777280d62d8b0c7127f8cb75760c0cfd230d
 SHA512:
-  metadata.gz: e072ba0a087c5e4d7a9b241ed78c22c2cf414173230ce29b92221af987e5f0f4ff9caa2005f219fac9c40f95b08801dbde1cb0295eddb807b70113b1f10d4ece
-  data.tar.gz: c8cec8884c51d10d8a2d3bc2673ab15dbd5c02f3b30b472a7765b91f5d1f4c6bd9c87b00f2acaeff01e3845b6e0edb79ecf84b79802a51f91034cc14f3895404
+  metadata.gz: 3c1ac9cbcf12be0ca4c48040a7f7e007b72f09932ef26ec4a4b40ac168a10ce04771a8587bfc25800b21166975204a986c6c2265269dfe2953bc90cf16608c7f
+  data.tar.gz: efe8de33f0365fcf871c0a160ddabeb4064e216a63fee7b9918af715d60dfd099e1881a124f8277d95e8ccb5c79df43eadfd660fa75f09f8f41c37806ce2e2f2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    arql (0.4.0)
+    arql (0.4.1)
       activerecord (>= 6.1.5, < 7.1.0)
       activesupport (>= 6.1.5, < 7.1.0)
       caxlsx (~> 3.3.0)

data/README-zh_CN.org

@@ -338,55 +338,6 @@
        l -c no|num  # 只显示字段名、字段注释中包含 no 或 num 的字段信息
      #+END_EXAMPLE
 
-**** =t=
-     
-     =t= 命令接受一个表名或模型类名作为参数，打印表的定义信息，例如：
-
-     执行 =t Person= 命令会打印 =person= 表的定义信息：
-
-     #+begin_example
-     Table: person
-     +----|------------|------------------|-----------|-------|-----------|-------|---------|----------|---------+
-     | PK | Name       | SQL Type         | Ruby Type | Limit | Precision | Scale | Default | Nullable | Comment |
-     +----|------------|------------------|-----------|-------|-----------|-------|---------|----------|---------+
-     | Y  | id         | int(11) unsigned | integer   | 4     |           |       |         | false    |         |
-     |    | name       | varchar(64)      | string    | 64    |           |       |         | true     |         |
-     |    | age        | int(11)          | integer   | 4     |           |       |         | true     |         |
-     |    | gender     | int(4)           | integer   | 4     |           |       |         | true     |         |
-     |    | grade      | int(4)           | integer   | 4     |           |       |         | true     |         |
-     |    | blood_type | varchar(4)       | string    | 4     |           |       |         | true     |         |
-     +----|------------|------------------|-----------|-------|-----------|-------|---------|----------|---------+
-     #+end_example
-
-     另外， =t= 同时也是模型类的一个类方法，执行 =Person.t= 会同样会打印出上述信息。
-
-     其中：
-
-     - =PK= : 是否为主键
-     - =Name= : 列名
-     - =SQL Type= : 数据库类型
-     - =Ruby Type= : Ruby 类型
-     - =Limit= : 长度限制
-     - =Precision= : 精度
-     - =Scale= : 小数位数
-     - =Default= : 默认值
-     - =Nullable= : 是否可为空
-     - =Comment= : 注释
-
-**** =vd=
-
-     =t= 命令在终端中以表格的形式打印表的定义信息，缺点是如果表的列数过多，会导致表格这行，不方便查看。而 =vd=
-     (visidata) 是一个使用 Python 编写的终端数据分析工具，可以在终端中以表格的形式打印表的定义信息，但是支持水平滚动，方
-     便查看。
-
-     如果要使用 Arql 的 =vd= 命令，需要先安装 =visidata=:
-
-      #+begin_src sh
-        pipx install visidata
-      #+end_src
-
-      =vd= 命令和用法和 =t= 命令基本相同，另外， =Array= / =ActiveRecord::Base= 等对象也可以使用 =vd= 方法。
-     
 **** =show-sql= / =hide-sql=
      
      这对命令可以切换 Pry REPL 中 SQL 日志的显示。
@@ -823,17 +774,13 @@
      =t= 方法还可以在包含 ActiveRecord 实例的数组上调用，也可以在 =ActiveRecord::Relation= / =ActiveRecord::Result= / =Ransack::Search= 对象上调用。
 
      #+begin_example
-     ARQL ❯ Person.last.t
-     +----------------|-----------------|------------------|---------+
-     | Attribute Name | Attribute Value | SQL Type         | Comment |
-     +----------------|-----------------|------------------|---------+
-     | id             | 11              | int(11) unsigned |         |
-     | name           | Jackson         | varchar(64)      |         |
-     | age            | 30              | int(11)          |         |
-     | gender         | 2               | int(4)           |         |
-     | grade          | 2               | int(4)           |         |
-     | blood_type     | AB              | varchar(4)       |         |
-     +----------------|-----------------|------------------|---------+
+     ARQL ❯ Person.last(2).t
+      +----+----------+--------+----------------------------------+-------+------+---------------------------+---------------------------+
+      | id | name     | gender | id_no                            | phone | note | gmt_created               | gmt_modified              |
+      +----+----------+--------+----------------------------------+-------+------+---------------------------+---------------------------+
+      | 90 | Zhangsan | M      | f09288fb381cc47dd2e56389cf15f0bf |       |      | 2021-04-26 15:32:05 +0800 | 2021-04-26 15:32:05 +0800 |
+      | 91 | Lisi     | F      | fb6fea4b23b1d3c54739774946246e4c |       |      | 2021-04-26 15:32:05 +0800 | 2021-04-26 15:32:05 +0800 |
+      +----+----------+--------+----------------------------------+-------+------+---------------------------+---------------------------+
      #+end_example
 
      作为数组和「类数组」对象实例方法时, =t= 方法可以接受多个用于过滤属性的参数，参数的类型可以是：
@@ -841,10 +788,10 @@
      + 字符串或 Symbol，对属性进行字面量匹配
      + 正则表达式，对属性进行正则匹配
 
-     例如, 只显示 =name=, =age= 以及所有名称包含 =time= 字样的属性：
+     例如, 只显示 =name=, =gender= 以及所有名称包含 =time= 字样的属性：
 
       #+begin_example
-      ARQL ❯ Person.last(10).t('name', :age, /time/i)
+      ARQL ❯ Person.last(2).t('name', :gender, /time/i)
       #+end_example
       
       作为数组和「类数组」对象的实例方法的 =t= 还可以接受以下三个选项:
@@ -852,7 +799,7 @@
      + =:except= 选项，用于指定不显示的属性名，值可以是字符串或正则表达式，例如：
        #+BEGIN_EXAMPLE
         Person.last(10).t(except: 'id')
-        Student.where(condition).t(except: /id|name/)
+        Student.where(condition).t(except: /id|gender/)
        #+END_EXAMPLE
      + =:compact= 选项，用于指定是否紧凑显示，值可以是 =true= 或 =false= ，如果启用紧凑显示，那些值全部为 =NULL= 的列将不
        会显示，这对于查看那些数据稀疏的表很有帮助，例如：
@@ -990,95 +937,6 @@
        id = ID.uuid # 生成一个 UUID
      #+END_EXAMPLE
 
-*** $C 全局变量
-     
-    Arql 将 =ActiveRecord::Base.connection= 对象赋值给全局可用的 =$C= 全局变量，它代表当前的数据库连接。
-
-    上文中的 =q= 方法实际上是 =$C.exec_query= 方法， =$C= 对象的其他方法也很有用：
-
-**** 创建表
-     #+begin_example
-     ARQL ❯ $C.create_table :post, id: false, primary_key: :id do |t|
-     ARQL ❯   t.column :id, :bigint, precison: 19, comment: 'ID'
-     ARQL ❯   t.column :name, :string, comment: '名称'
-     ARQL ❯   t.column :gmt_created, :datetime, comment: '创建时间'
-     ARQL ❯   t.column :gmt_modified, :datetime, comment: '最后修改时间'
-     ARQL ❯ end
-     #+end_example
-
-     =create_table= 同样也被加入到 =Kernel= 下面，所以也可以直接调用 =create_table= 方法：
-
-     #+begin_example
-     ARQL ❯ create_table :post, id: false, primary_key: :id do |t|
-     ARQL ❯   t.column :id, :bigint, precison: 19, comment: 'ID'
-     ARQL ❯   t.column :name, :string, comment: '名称'
-     ARQL ❯   t.column :gmt_created, :datetime, comment: '创建时间'
-     ARQL ❯   t.column :gmt_modified, :datetime, comment: '最后修改时间'
-     ARQL ❯ end
-     #+end_example
-
-**** 添加字段
-      
-     #+begin_example
-     $C.add_column :post, :note, :string, comment: '备注'
-     #+end_example
-
-     =add_column= 也被加入到模型类的类方法中，所以也可以直接在模型类上调用 =add_column= 方法：
-
-     #+begin_example
-     Post.add_column :note, :string, comment: '备注'
-     #+end_example
-
-**** 修改字段
-      
-     #+begin_example
-     $C.change_column :post, :note, :text, comment: '备注'
-     #+end_example
-
-     =change_column= 也被加入到模型类的类方法中，所以也可以直接在模型类上调用 =change_column= 方法：
-
-     #+begin_example
-     Post.change_column :note, :text, comment: '备注'
-     #+end_example
-
-**** 删除字段
-      
-     #+begin_example
-     $C.remove_column :post, :note
-     #+end_example
-
-     =remove_column= 也被加入到模型类的类方法中，所以也可以直接在模型类上调用 =remove_column= 方法：
-
-     #+begin_example
-     Post.remove_column :note
-     #+end_example
-
-**** 删除表
-      
-     #+begin_example
-     $C.drop_table :post
-     #+end_example
-
-     =drop_table= 也被加入到模型类的类方法中，所以也可以直接在模型类上调用 =drop_table= 方法：
-
-     #+begin_example
-     Post.drop_table
-     #+end_example
-
-**** 添加索引
-      
-     #+begin_example
-     ARQL ❯ $C.add_index :post, :name
-     ARQL ❯ $C.add_index(:accounts, [:branch_id, :party_id], unique: true, name: 'by_branch_party')
-     #+end_example
-
-     =add_index= 也被加入到模型类的类方法中，所以也可以直接在模型类上调用 =add_index= 方法：
-
-     #+begin_example
-     Post.add_index :name
-     Post.add_index [:branch_id, :party_id], unique: true, name: 'by_branch_party'
-     #+end_example
-
 *** 读写 Excel 和 CSV 文件
 
     Arql 集成了 =roo= 和 =caxlsx= 两个 Excel 库，提供了用于解析和生成 Excel 文件的方法。同时，Arql 也提供了用于读写 CSV 文件的方法。
@@ -1272,16 +1130,6 @@
        =no_create_table= 参数指定是否在 SQL 文件中包含创建表的语句，默认值为 =false= 。
 
         
-**** 在全局连接对象 =$C= 上调用 dump 方法
-
-       #+BEGIN_EXAMPLE
-         ARQL ❯ $C.dump 'path/to/dump.sql', no_create_db: false
-       #+END_EXAMPLE
-
-       这个方法会通过 mysqldump 命令把当前数据库中的所有表的数据导出到 SQL 文件中。
-
-       =no_create_db= 参数指定是否在 SQL 文件中包含创建数据库的语句，默认值为 =false= 。
-        
 *** Plot
 
     Arql 集成了 Ruby 的 =youplot= 库，为 =Array= 添加了一些可以用来绘制图表的方法：