Merge pull request #132 from itsumura-h/feature/131_index

add index

allographer.nimble

@@ -1,6 +1,6 @@
 # Package
 
-version       = "0.13.6"
+version       = "0.14.0"
 author        = "Hidenobu Itsumura @dumblepytech1 as 'medy'"
 description   = "A Nim query builder library inspired by Laravel/PHP and Orator/Python"
 license       = "MIT"

documents/schema_builder.md

@@ -147,7 +147,8 @@ alter(
 |`.nullable()`|Designate that the column allows NULL values|
 |`.default(value)`|Declare a default value for a column|
 |`.unsigned()`|Set INTEGER to UNSIGNED|
-|`.unique()`|Adding a unique index|
+|`.unique()`|Adding an unique index|
+|`.index()`|Adding an index|
 
 ## Foreign Key Constraints
 For example, let's define a `user_id` column on the table that references the `id` column on a `users` table:

example/migrate.nim

@@ -1,9 +1,7 @@
-import strformat, json, progress
+import strformat, json, progress, oids
 import bcrypt
 import ../src/allographer/query_builder
 import ../src/allographer/schema_builder
-# import allographer/query_builder
-# import allographer/schema_builder
 
 
 # マイグレーション
@@ -14,13 +12,15 @@ schema([
   ], reset=true),
   table("Users",[
     Column().increments("id"),
+    Column().string("oid").index().nullable(),
+    Column().string("oid2").index(),
     Column().string("Name").nullable(),
     Column().string("email").nullable(),
     Column().string("password").nullable(),
     Column().string("address").nullable(),
     Column().date("birth_date").nullable(),
     Column().foreign("auth_id").reference("id").on("Auth").onDelete(SET_NULL)
-  ], reset=true)
+  ], reset=true),
 ])
 
 # シーダー
@@ -41,6 +41,8 @@ for i in 1..total:
   let authId = if i mod 2 == 0: 1 else: 2
   insertData.add(
     %*{
+      "oid": $(genOid()),
+      "oid2": $(genOid()),
       "Name": &"user{i}",
       "email": &"user{i}@gmail.com",
       "password": password,

src/allographer/query_builder/exec.nim

@@ -1,6 +1,6 @@
 import json, strutils, strformat, algorithm, options, asyncdispatch
 import base, builders
-import ../util
+import ../utils
 import ../connection
 
 

src/allographer/query_builder/generators.nim

@@ -3,7 +3,7 @@ from strformat import `&`
 from strutils import contains, isUpperAscii
 
 import base
-from ../util import wrapUpper
+from ../utils import wrapUpper
 
 
 # ==================== SELECT ====================

src/allographer/schema_builder/alter.nim

@@ -4,7 +4,7 @@ import
   ./alters/sqlite_alter,
   ./alters/mysql_alter,
   ./alters/postgres_alter
-import ../util
+import ../utils
 import ../connection
 
 

src/allographer/schema_builder/alters/mysql_alter.nim

@@ -2,7 +2,7 @@ import strformat, re, strutils
 import ../table
 import ../column
 import ../migrates/mysql_migrate
-import ../../util
+import ../../utils
 import ../../connection
 
 proc add(column:Column, table:string) =

src/allographer/schema_builder/alters/postgres_alter.nim

@@ -2,7 +2,7 @@ import strformat, re, strutils
 import ../table
 import ../column
 import ../migrates/postgres_migrate
-import ../../util
+import ../../utils
 import ../../connection
 
 proc add(column:Column, table:string) =

src/allographer/schema_builder/alters/sqlite_alter.nim

@@ -2,7 +2,7 @@ import strformat, re, strutils
 import ../table
 import ../column
 import ../migrates/sqlite_migrate
-import ../../util
+import ../../utils
 import ../../connection
 
 proc add(column:Column, table:string) =

src/allographer/schema_builder/column.nim

@@ -5,6 +5,7 @@ type
   Column* = ref object
     name*: string
     typ*: RdbTypekind
+    isIndex*: bool
     isNullable*: bool
     isUnsigned*: bool
     isDefault*: bool
@@ -93,6 +94,10 @@ proc default*(c:Column):Column =
   c.isDefault = true
   return c
 
+proc index*(c:Column):Column =
+  c.isIndex = true
+  return c
+
 proc nullable*(c: Column): Column =
   c.isNullable = true
   return c

src/allographer/schema_builder/generators/mysql_generators.nim

@@ -1,5 +1,6 @@
 import json, strformat
-import ../column, utils
+import ../column, generator_util
+import ../../utils
 
 # =============================================================================
 # int
@@ -374,6 +375,10 @@ proc foreignGenerator*(name:string, table:string, column:string,
   elif foreignOnDelete == NO_ACTION:
     onDeleteString = "NO ACTION"
 
-
   result = &", FOREIGN KEY(`{name}`) REFERENCES {table}({column})"
   result.add(&" ON DELETE {onDeleteString}")
+
+proc indexGenerate*(table, column:string):string =
+  var table = table
+  wrapUpper(table)
+  return &"CREATE INDEX {column}_index ON {table}({column})"

src/allographer/schema_builder/generators/postgres_generators.nim

@@ -1,7 +1,7 @@
 import json, strformat
 import ../column
-import utils
-import ../../util
+import generator_util
+import ../../utils
 
 # =============================================================================
 # int
@@ -403,3 +403,8 @@ proc foreignGenerator*(name:string, tableName:string, column:string,
   wrapUpper(tableName)
   result = &", FOREIGN KEY(\"{name}\") REFERENCES {tableName}({column})"
   result.add(&" ON DELETE {onDeleteString}")
+
+proc indexGenerate*(table, column:string):string =
+  var table = table
+  wrapUpper(table)
+  return &"CREATE INDEX {column}_index ON {table}({column})"

src/allographer/schema_builder/generators/sqlite_generators.nim

@@ -1,5 +1,6 @@
 import json, strformat
 import ../column
+import ../../utils
 from db_common import DbError
 
 # =============================================================================
@@ -285,3 +286,8 @@ proc foreignGenerator*(name:string, table:string, column:string,
 
   result = &", FOREIGN KEY('{name}') REFERENCES {table}({column})"
   result.add(&" ON DELETE {onDeleteString}")
+
+proc indexGenerate*(table, column:string):string =
+  var table = table
+  wrapUpper(table)
+  return &"CREATE INDEX {column}_index ON {table}({column})"

src/allographer/schema_builder/migrates/mysql_migrate.nim

@@ -3,7 +3,7 @@ import
   ../table,
   ../column
 import ../generators/mysql_generators
-import ../../util
+import ../../utils
 
 
 proc generateColumnString*(column:Column):string =
@@ -279,3 +279,6 @@ proc migrate*(this:Table):string =
   var tableName = this.name
   wrapUpper(tableName)
   return &"CREATE TABLE {tableName} ({columnString}{foreignString})"
+
+proc createIndex*(table, column:string):string =
+  return indexGenerate(table, column)