eugene 0.8.3

Careful with That Lock, Eugene
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

## ✅ Eugene lint report

Script name: `examples/W14/good/1.sql`

This is a human readable SQL lint report generated by [eugene](https://github.com/kaaveland/eugene).
Keep in mind that lint rules can be ignored in the following two ways:

  1. By appending comment directives like `-- eugene: ignore E123` to the SQL statement.
  2. By passing `--ignore E123` on the command line.

### ✅ Statement number 1

```sql
-- 1.sql
create table authors(
    name text
)
```

## ✅ Eugene lint report

Script name: `examples/W14/good/2.sql`

This is a human readable SQL lint report generated by [eugene](https://github.com/kaaveland/eugene).
Keep in mind that lint rules can be ignored in the following two ways:

  1. By appending comment directives like `-- eugene: ignore E123` to the SQL statement.
  2. By passing `--ignore E123` on the command line.

### ✅ Statement number 1

```sql
-- 2.sql
create unique index concurrently
    authors_name_key on authors(name)
```

## ✅ Eugene lint report

Script name: `examples/W14/good/3.sql`

This is a human readable SQL lint report generated by [eugene](https://github.com/kaaveland/eugene).
Keep in mind that lint rules can be ignored in the following two ways:

  1. By appending comment directives like `-- eugene: ignore E123` to the SQL statement.
  2. By passing `--ignore E123` on the command line.

### ✅ Statement number 1

```sql
-- 3.sql
set local lock_timeout = '2s'
```

### ✅ Statement number 2

```sql
-- eugene: ignore E2
-- This is a demo of W14, so we can ignore E2 instead of the
-- multi-step migration to make the column NOT NULL safely
alter table authors
    alter column name set not null
```

## ❌ Eugene lint report

Script name: `examples/W14/good/4.sql`

This is a human readable SQL lint report generated by [eugene](https://github.com/kaaveland/eugene).
Keep in mind that lint rules can be ignored in the following two ways:

  1. By appending comment directives like `-- eugene: ignore E123` to the SQL statement.
  2. By passing `--ignore E123` on the command line.

### ❌ Statement number 1

```sql
-- 4.sql
alter table authors
    add constraint authors_name_pkey
        primary key using index authors_name_key
```

#### Triggered rules

##### `E9`: [Taking dangerous lock without timeout](https://kaveland.no/eugene/hints/E9/)

Statement takes lock on `public.authors`, but does not set a lock timeout.

##### `W14`: [Adding a primary key using an index](https://kaveland.no/eugene/hints/W14/)

New primary key constraint using index on `public.authors`, may cause postgres to `SET NOT NULL` on columns in the index. This lint may be a false positive if the columns are already `NOT NULL`, ignore it by commenting the statement with `-- eugene: ignore W14`.