pg_tviews 0.1.0-beta.12

Transactional materialized views with incremental refresh for PostgreSQL
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# Deprecation Warning System

## For SQL Users

### Example: Deprecated Function

```sql
-- Function deprecated in 0.2.0
-- Will be removed in 1.0.0 (Apr 2026)
SELECT pg_tviews_legacy_function();

-- Output includes warning:
-- WARNING: pg_tviews_legacy_function() is deprecated
-- Use: pg_tviews_new_function() instead
-- See: docs/migration/0.2-upgrade-guide.md
```

### Checking for Deprecations

```sql
-- Query deprecation status of all functions
SELECT pg_describe_object(classid, objid, objsubid) as function,
       obj_description(objid, 'pg_proc') as description
FROM pg_depend
WHERE deptype = 'n'  -- Dependency on normal object
  AND classid = 'pg_proc'::regclass
ORDER BY function;
```

## For Rust Users

### Example: Deprecated Struct

```rust
#[deprecated(
    since = "0.2.0",
    note = "Use `ViewRow` instead. See docs/migration/0.2-upgrade-guide.md"
)]
pub struct LegacyViewRow { /* ... */ }

// When used:
// warning: use of deprecated struct `LegacyViewRow`
//   --> src/main.rs:10:5
//    |
// 10 |     let row = LegacyViewRow::new();
//    |         ^^^
//    |
//    = note: Use `ViewRow` instead...
```

### Suppressing Deprecation Warnings (Temporary)

```rust
#[allow(deprecated)]
fn legacy_code() {
    let row = LegacyViewRow::new();  // No warning
}
```

## Timeline for Deprecation

### Phase 1: Announce (Released)
- Deprecation noted in release notes
- Documentation updated with alternative
- Migration guide published (if complex)

### Phase 2: Warn (Next version)
- Deprecation warning added to code
- Warning appears when function/type used
- Still fully functional

### Phase 3: Remove (Major version only)
- Function/type removed completely
- Listed in breaking changes
- Migration guide required

### Example Timeline

```
v0.2.0 (Released Aug 2025)
  ├─ ANNOUNCE: Deprecate pg_tviews_legacy_func()
  ├─ New alternative: pg_tviews_new_func()
  └─ Guide: docs/migration/0.2-upgrade.md

v0.3.0 (Released Oct 2025)
  ├─ WARN: legacy_func() shows deprecation warning
  └─ Still works, but warns users

v1.0.0 (Released Apr 2026) [NEW MAJOR VERSION]
  ├─ REMOVED: legacy_func() no longer exists
  └─ Users MUST migrate by this date
```

Timeline: Aug 2025 → Apr 2026 = 8 months notice
Policy minimum: 6 months

## How to Report Deprecations

When deprecating a feature:

1. **Add to code**:
```rust
#[deprecated(
    since = "0.2.0",
    note = "Use alternative. See [migration guide](docs/url)"
)]
```

2. **Update CHANGELOG.md**:
```
## [0.2.0]
### Deprecated
- `legacy_function()` in favor of `new_function()`
```

3. **Create migration guide**:
- File: `docs/migration/0.2-upgrade-guide.md`
- Include before/after examples
- Common gotchas
- Troubleshooting