Episode #125 of the Stack Overflow podcast is here. We talk Tilde Club and mechanical keyboards. Listen now

Questions tagged [documentation]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
226
votes
18answers
106k views

How do you document your databases?

I find that most of my clients are not documenting their databases at all and I find that pretty scary. To introduce some better practice, I would like to know what tools/process people are using. ...
12
votes
4answers
3k views

Where to start to understand a unknown database

So, the title sums it up. I've got a SQL Server database with 28 tables and 86 stored procedures that must be reverse engineered. I'm pretty sure that some tables are never used and that not all ...
11
votes
3answers
4k views

Documenting a giant web of inter-related stored procedures in an MS SQL database: What tool or format?

I hope this is a question with a shorter answer than "Read a 1000 page book", but then, if that's the real situation, then hit me with it. I am not a real DBA, I'm a software developer who is ...
10
votes
4answers
463 views

How to tackle a large undocumented database

I recently got hired as the only IT Guy in a certain Company X and I am tasked to fix their applications, and in my opinion, the best way to start is by understanding the database. Their current ...
9
votes
6answers
11k views

Best way to document database mappings for migrations [closed]

I'm working on a project that includes mapping database elements for a migration and I wanted to know what tools others were using to do this? Excel is a very flexible way to document simple ...
7
votes
4answers
3k views

How to document Oracle database?

I'm new to Oracle databases. I have used to SQL Server and the description fields (MS_Description) for tables and columns for documentation purposes. Is there an equivalent for Oracle? What is the ...
5
votes
2answers
2k views

Where can I find a syntax reference for Oracle SQL Developer's “Generate DB Doc” function?

Oracle SQL Developer (I'm using v3.2) has a feature called "DB Doc", which generates documentation for database objects. I mostly want to use it to generate documentation for my stored procedures, ...
4
votes
2answers
519 views

Is index_type ignored on MySQL primary keys in create table?

I have seen a create table whose primary key had an identifier where it should have an index_type, something like that: create table a (foo INTEGER, PRIMARY KEY foo_id (foo)); The thing is that ...
4
votes
1answer
869 views

Writing a database analysis document

I've been tasked with writing an analysis of a database that is currently used on a small scale. The intent of the document is to show to the business (as well as technically) that the database can ...
3
votes
1answer
226 views

Conversions between any data type and the binary data types are not guaranteed to be the same between versions of SQL Server

I just found that on the SQL Server 2012 MSDN documentation for binary and varbinary types, they mention the following at the end of the article: Conversions between any data type and the binary ...
3
votes
1answer
6k views

Print table documentation with comments?

I have a MySQL database, and I have used MySQL Workbench to insert text into the "comment" fields of many of the columns and tables; the plan was to have the documentation stored in the database. ...
3
votes
2answers
3k views

SQL Server DR Plan - Test Documentation

I have been tasked with creating a document for the testing of our DR/BC Plan for our SQL Servers. We are using DB Mirroring (tier-1) and transaction log shipping (tier-2) and for tier-3 databases we ...
3
votes
1answer
63 views

What process would you use to determine references on a database that has no integrity?

Imagine you inherit a database which has a bunch of tables, no documentation and zero referential integrity. Now you're trying to find out what are the various relationships between different tables. ...
3
votes
1answer
63 views

Are there best practices or standardized syntax for writing transformation logic?

This may not be the appropriate forum, but its the closest I could find. I write a lot of source to target mappings for work. These documents just describe the operations/logic/transformations/etc. ...
3
votes
0answers
1k views

Quickly edit MS_Description in SSMS

We document our database by storing descriptions for tables, columns, stored procedures etc. in the MS_Description extended property. It's easy enough to handle by scripting, but what I miss is some ...
2
votes
3answers
2k views

Question about 'user process' in the context of Oracle

The following is an except from oracle documentation. Overview of User Processes When a user runs an application program (such as a Pro*C program) or an Oracle tool (such as Enterprise ...
2
votes
4answers
191 views

What permissions are required for UPDATE STATISTICS #table WITH ROWCOUNT = xxx?

Can anyone point me to the correct documentation or additional permissions I need besides SA to do the following? When I run it, I receive the following error: Cannot find the object "#test" because ...
2
votes
1answer
2k views

DB2 cookbook by Graeme Birchall?

Not sure if this question is appropriate here but I believe that it is of some interest for the db2:ers of the site. Once upon a time the DB2 Cookbook by Graeme Birchall could be downloaded from: ...
2
votes
1answer
6k views

log_warnings doesn't seem to work for aborted connections in MySQL 5.1

The docs for 5.1 say that I can set log_warnings = 2 to capture Aborted_connects in the error log. This bug report suggests that this was only merged into 5.5 and 6.0 (and maybe 5.2) but not into 5.1....
2
votes
1answer
254 views

Documenting SSRS and SSIS jobs that are the Job Activity Monitor

We are running a SQL Server 2014 database using SSRS as a reporting tool. We have data coming in via SSIS jobs and linked servers. We have developers creating various SSRS jobs and scheduling them. ...
2
votes
1answer
588 views

Can I export a MySQL schema to latex? [closed]

I have asked this question on SO before, but did not get a good answer. I would like to be able to export a MySQL schema to a set of Latex tables. phpMyAdmin does this, but it is buggy and does not ...
1
vote
2answers
184 views

Extent Allocation Mechanism in SQL Server 2017

I was looking at the SQL Server 2017 Documentation for page and extent allocations. What I got to know from online resources and sessions in SQL conferences: Starting with SQL Server 2016, Uniform ...
1
vote
2answers
466 views

How do I navigate PostgreSQL documentation to find a list of all functions that work on a specific type?

Let's say I want to find a list of functions that can work on jsonb, what is the most effective way to do this from the terminal without using google? Assuming only access to man pages psql ...
1
vote
1answer
238 views

Best way to document Dwh views [closed]

I works in a company that provide Dwh views as an API for external Customers (We use MS-SQL 2008 & 2012). every once in a while we release new views and updates the existing views. We have ...
1
vote
1answer
119 views

Documenting a collection of databases and their relationships with each other

As part of a project I'm currently involved with we need to identify where various data points are held within existing systems, with a view to integrating them into our central integration engine. We'...
1
vote
2answers
577 views

Curious About SQL Server Registry Entries

I'm working on building some documentation across my systems and planned on simply using Powershell to script out the legwork of what I wanted to do. While that's going all well and good, I ran into ...
0
votes
2answers
5k views

Can't see some stored procedures in sys.procedures

Documenting a database and find that I cannot see stored procedures in sys.procedures, even though I can see them in Object Explorer. select p.name, x.value, p.modify_date from sys.procedures p left ...
0
votes
1answer
20 views

Is there a postgres function documentation pattern that is similar in concept to javadoc?

I am mostly a Java developer. Today I am writing some postgres functions. Out of habit I keep trying to document these functions using a Javadoc-like comment style describing the function parameters ...
0
votes
1answer
401 views

What is the syntax to add a constraint on an already-created table?

PostgreSQL exclusion constraints are documented briefly under DDL-Constraints CREATE TABLE .. CONSTRAINT .. EXCLUDE As linked in ddl-constraint But, the syntax for ALTER TABLE does not mention /...
0
votes
1answer
36 views

mysql french documentation [closed]

I am not able to find a translation for Mysql documentation http://dev.mysql.com/doc/ I read English quite well, but it is not the case for all my colleagues.
0
votes
1answer
64 views

Generate metadata file from PostgreSQL server [closed]

Is there a way that I can make a metadata-sheet that lists all the available tables from a postgresql-database, so users can see documentation of the tables? I know that there are descriptions, ...
0
votes
1answer
230 views

Documenting SQL Server Database [duplicate]

I wrote the following (Quick and Dirty) script to document a database schema: Note - The relationships part came from another guys site (I just can't remember where). Does anyone know how to ...
0
votes
1answer
125 views

Error when building documentation of Postgres [closed]

I am trying to build the documentation of Postgres on OSX After getting the source, installing node and jade, I do: cd /doc/src/sgml make html This results in the error: fs.js:684 return ...
0
votes
0answers
33 views

How to Analyze and Document a SQL Server Stored Procedure

I have been handed a large SQL Server batch process containing <100 stored procedures and functions. There is no documentation, I cannot rely on comments. High level, what are the best practices ...
0
votes
0answers
62 views

Where to find documentation about the log reader procedures?

From the replication monitor in sql server transactional replication, when I have a look at what has been replicated, from publisher to the distributor, I get the following picture: It does not show ...
0
votes
2answers
70 views

Useful formats for the results of a database “audit”? [duplicate]

My company has tons of disparate databases - Oracle, SQL Server, and (shudder) MS Access - lying around, and the CIO wants to bring in a third party to track them all down and document them. But, ...
-2
votes
3answers
78 views

Determine which data a SQL login account has access to?

I am a new DBA and am trying to do some documentation on the SQL estate that I am responsible for. Currently I have no documentation on anything so this is all from scratch. I am hoping to find out if ...