Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

fix(studio): allow selecting columns for empty-cell NULL conversion on CSV import (#44515)

Usama Nadeem33c890f564b4
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.tsx
index ea6d7f04c43..cffd091938c 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.tsx
@@ -842,7 +842,7 @@ export const SidePanelEditor = ({
return console.error('no project or table selected')
}
- const { file, rowCount, selectedHeaders, resolve } = importContent
+ const { file, rowCount, selectedHeaders, emptyStringAsNullHeaders, resolve } = importContent
const toastId = toast.loading(
`Adding ${rowCount.toLocaleString()} rows to ${selectedTable.name}`
)
@@ -854,6 +854,7 @@ export const SidePanelEditor = ({
file,
table: selectedTable,
selectedHeaders,
+ emptyStringAsNullHeaders,
onProgressUpdate: (progress: number) => {
toast.loading(
<SonnerProgress
@@ -863,7 +864,6 @@ export const SidePanelEditor = ({
{ id: toastId }
)
},
- treatEmptyAsNull: importContent.treatEmptyAsNull,
})
if (res.error) {
const message = isObjectContainingKeys(res.error, ['message'])
@@ -879,6 +879,7 @@ export const SidePanelEditor = ({
table: selectedTable,
rows: importContent.rows,
selectedHeaders,
+ emptyStringAsNullHeaders,
onProgressUpdate: (progress: number) => {
toast.loading(
<SonnerProgress
@@ -890,7 +891,6 @@ export const SidePanelEditor = ({
{ id: toastId }
)
},
- treatEmptyAsNull: importContent.treatEmptyAsNull,
})
if (res.error) {
const message = isObjectContainingKeys(res.error, ['message'])
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.utils.test.ts b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.utils.test.ts
index a47f133a00e..dacd54caecd 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.utils.test.ts
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.utils.test.ts
@@ -41,6 +41,31 @@ describe('SidePanelEditor.utils.test.ts', () => {
])
})
+ test('formatRowsForInsert should only convert empty strings to null for selected columns', () => {
+ const rows = [
+ { id: 1, name: '', email: '' },
+ { id: 2, name: 'Bob', email: '' },
+ ]
+ const headers = ['id', 'name', 'email']
+ const columns = [
+ { id: '1', name: 'id', data_type: 'bigint', format: 'int8', is_nullable: false },
+ { id: '2', name: 'name', data_type: 'text', format: 'text', is_nullable: true },
+ { id: '3', name: 'email', data_type: 'text', format: 'text', is_nullable: true },
+ ]
+
+ const formattedRows = formatRowsForInsert({
+ rows,
+ headers,
+ columns: columns as any,
+ emptyStringAsNullHeaders: ['email'],
+ })
+
+ expect(formattedRows).toEqual([
+ { id: 1, name: '', email: null },
+ { id: 2, name: 'Bob', email: null },
+ ])
+ })
+
test('formatRowsForInsert should handle JSON object values properly', () => {
const rows = [{ id: 1, value: '{"key": "value"}' }]
const headers = ['id', 'value']
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.utils.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.utils.tsx
index 34e30187808..ebe48d6929c 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.utils.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SidePanelEditor.utils.tsx
@@ -679,7 +679,7 @@ export const createTable = async ({
{ id: toastId }
)
},
- treatEmptyAsNull: importContent.treatEmptyAsNull,
+ emptyStringAsNullHeaders: importContent.emptyStringAsNullHeaders,
})
if (error !== undefined) {
@@ -715,7 +715,7 @@ export const createTable = async ({
{ id: toastId }
)
},
- treatEmptyAsNull: importContent.treatEmptyAsNull,
+ emptyStringAsNullHeaders: importContent.emptyStringAsNullHeaders,
})
}
@@ -970,12 +970,12 @@ export const formatRowsForInsert = ({
rows,
headers,
columns = [],
- treatEmptyAsNull = true,
+ emptyStringAsNullHeaders = headers,
}: {
rows: unknown[]
headers: string[]
columns?: RetrieveTableResult['columns']
- treatEmptyAsNull?: boolean
+ emptyStringAsNullHeaders?: string[]
}) => {
return rows.map((row) => {
const formattedRow: Record<string, unknown> = {}
@@ -988,9 +988,7 @@ export const formatRowsForInsert = ({
const originalValue = row[header]
- if (originalValue === '' && treatEmptyAsNull && column?.is_nullable) {
- formattedRow[header] = null
- } else if ((column?.format ?? '').includes('json')) {
+ if ((column?.format ?? '').includes('json')) {
formattedRow[header] = tryParseJson(originalValue)
} else if ((column?.data_type ?? '') === 'ARRAY') {
if (
@@ -1004,7 +1002,8 @@ export const formatRowsForInsert = ({
formattedRow[header] = tryParseJson(originalValue)
}
} else if (originalValue === '') {
- formattedRow[header] = ''
+ formattedRow[header] =
+ column?.is_nullable && emptyStringAsNullHeaders.includes(header) ? null : ''
} else {
formattedRow[header] = originalValue
}
@@ -1019,16 +1018,16 @@ export async function insertRowsViaSpreadsheet({
file,
table,
selectedHeaders,
+ emptyStringAsNullHeaders = selectedHeaders,
onProgressUpdate,
- treatEmptyAsNull = true,
}: {
projectRef: string
connectionString: string | undefined | null
file: File
table: RetrieveTableResult
selectedHeaders: string[]
+ emptyStringAsNullHeaders?: string[]
onProgressUpdate: (progress: number) => void
- treatEmptyAsNull: boolean
}): Promise<{ error: unknown }> {
let chunkNumber = 0
let insertError: unknown = undefined
@@ -1048,7 +1047,7 @@ export async function insertRowsViaSpreadsheet({
rows: results.data,
headers: selectedHeaders,
columns: table.columns,
- treatEmptyAsNull,
+ emptyStringAsNullHeaders,
})
const insertQuery = new Query().from(table.name, table.schema).insert(formattedData).toSql()
@@ -1085,16 +1084,16 @@ export async function insertTableRows({
table,
rows,
selectedHeaders,
+ emptyStringAsNullHeaders = selectedHeaders,
onProgressUpdate,
- treatEmptyAsNull = true,
}: {
projectRef: string
connectionString: string | undefined | null
table: RetrieveTableResult
rows: unknown[]
selectedHeaders: string[]
+ emptyStringAsNullHeaders?: string[]
onProgressUpdate: (progress: number) => void
- treatEmptyAsNull: boolean
}): Promise<{ error: unknown }> {
let insertError: unknown = undefined
let insertProgress = 0
@@ -1103,7 +1102,7 @@ export async function insertTableRows({
rows,
headers: selectedHeaders,
columns: table.columns,
- treatEmptyAsNull,
+ emptyStringAsNullHeaders,
})
const batches = chunk(formattedRows, BATCH_SIZE)
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadSheetImportConfiguration.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadSheetImportConfiguration.tsx
index 66b0ab17aca..7fb2dad8dde 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadSheetImportConfiguration.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadSheetImportConfiguration.tsx
@@ -1,6 +1,7 @@
import { ChevronDown } from 'lucide-react'
import { useState } from 'react'
-import { Button, Checkbox_Shadcn_, cn, Collapsible, Label_Shadcn_, SidePanel } from 'ui'
+import { Button, cn, Collapsible, SidePanel } from 'ui'
+import { MultiSelector } from 'ui-patterns/multi-select'
import type { SpreadsheetData } from './SpreadsheetImport.types'
@@ -8,18 +9,21 @@ interface SpreadSheetImportConfigurationProps {
spreadsheetData: SpreadsheetData
selectedHeaders: string[]
onToggleHeader: (header: string) => void
- treatEmptyAsNull: boolean
- onToggleTreatEmptyAsNull: () => void
+ emptyStringAsNullHeaders: string[]
+ onEmptyStringAsNullHeadersChange: (headers: string[]) => void
}
const SpreadsheetImportConfiguration = ({
spreadsheetData,
selectedHeaders,
onToggleHeader,
- treatEmptyAsNull,
- onToggleTreatEmptyAsNull,
+ emptyStringAsNullHeaders,
+ onEmptyStringAsNullHeadersChange,
}: SpreadSheetImportConfigurationProps) => {
const [expandConfiguration, setExpandConfiguration] = useState(false)
+ const importableHeaders = spreadsheetData.headers.filter((header) =>
+ selectedHeaders.includes(header)
+ )
return (
<Collapsible open={expandConfiguration} onOpenChange={setExpandConfiguration} className={''}>
@@ -52,19 +56,6 @@ const SpreadsheetImportConfiguration = ({
By default, all columns are selected to be imported from your CSV
</p>
</div>
- <div className="flex items-center gap-2">
- <Checkbox_Shadcn_
- id="treat-empty-as-null"
- checked={treatEmptyAsNull}
- onCheckedChange={onToggleTreatEmptyAsNull}
- />
- <Label_Shadcn_
- htmlFor="treat-empty-as-null"
- className="text-sm text-foreground-light cursor-pointer"
- >
- Treat empty cells as <code className="text-xs">NULL</code>
- </Label_Shadcn_>
- </div>
<div className="flex items-center flex-wrap gap-2 pl-0.5 pb-0.5">
{spreadsheetData.headers.map((header) => {
const isSelected = selectedHeaders.includes(header)
@@ -82,6 +73,38 @@ const SpreadsheetImportConfiguration = ({
)
})}
</div>
+ <div className="space-y-2">
+ <div>
+ <p className="text-sm text-foreground-light">Set empty cells as NULL</p>
+ <p className="text-sm text-foreground-light">
+ Empty cells will only be converted to NULL for the selected imported columns
+ </p>
+ </div>
+ <MultiSelector
+ values={emptyStringAsNullHeaders}
+ onValuesChange={onEmptyStringAsNullHeadersChange}
+ disabled={importableHeaders.length === 0}
+ >
+ <MultiSelector.Trigger
+ badgeLimit="wrap"
+ label={
+ importableHeaders.length === 0
+ ? 'No imported columns selected'
+ : 'Select columns...'
+ }
+ mode="inline-combobox"
+ />
+ <MultiSelector.Content>
+ <MultiSelector.List>
+ {importableHeaders.map((header) => (
+ <MultiSelector.Item key={header} value={header}>
+ {header}
+ </MultiSelector.Item>
+ ))}
+ </MultiSelector.List>
+ </MultiSelector.Content>
+ </MultiSelector>
+ </div>
</div>
</SidePanel.Content>
</Collapsible.Content>
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImport.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImport.tsx
index 29361c652c4..3b2b1a9bb77 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImport.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImport.tsx
@@ -40,12 +40,10 @@ export const SpreadsheetImport = ({
}: SpreadsheetImportProps) => {
const { ref: projectRef } = useParams()
const { data: org } = useSelectedOrganizationQuery()
-
const {
state,
- treatEmptyAsNull,
handleSwitchTab,
- handleToggleTreatEmptyAsNull,
+ handleSetEmptyStringAsNullHeaders,
handleInputText,
handleUploadFile,
handleRemoveFile,
@@ -54,8 +52,6 @@ export const SpreadsheetImport = ({
const tab = isFileTab(state) ? 'fileUpload' : 'pasteText'
const selectedTableColumns = (selectedTable?.columns ?? []).map((column) => column.name)
- const csvHeaders =
- state._tag === 'file_parsed' || state._tag === 'text_parsed' ? state.data.headers : []
const selectedHeaders =
state._tag === 'file_parsed' || state._tag === 'text_parsed' ? state.selectedHeaders : []
const incompatibleHeaders = selectedHeaders.filter(
@@ -87,7 +83,7 @@ export const SpreadsheetImport = ({
file: state._tag === 'file_parsed' ? state.file : undefined,
...state.data,
selectedHeaders: state.selectedHeaders,
- treatEmptyAsNull: treatEmptyAsNull,
+ emptyStringAsNullHeaders: state.emptyStringAsNullHeaders,
resolve,
})
sendEvent({
@@ -152,8 +148,8 @@ export const SpreadsheetImport = ({
spreadsheetData={state.data}
selectedHeaders={state.selectedHeaders}
onToggleHeader={handleToggleSelectedHeader}
- treatEmptyAsNull={treatEmptyAsNull}
- onToggleTreatEmptyAsNull={handleToggleTreatEmptyAsNull}
+ emptyStringAsNullHeaders={state.emptyStringAsNullHeaders}
+ onEmptyStringAsNullHeadersChange={handleSetEmptyStringAsNullHeaders}
/>
<SidePanel.Separator />
<SpreadsheetImportPreview
@@ -162,6 +158,7 @@ export const SpreadsheetImport = ({
errors={state.errors}
selectedHeaders={state.selectedHeaders}
incompatibleHeaders={incompatibleHeaders}
+ emptyStringAsNullHeaders={state.emptyStringAsNullHeaders}
/>
<SidePanel.Separator />
</>
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImport.utils.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImport.utils.tsx
index 2833e507988..c0d0a52d722 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImport.utils.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImport.utils.tsx
@@ -19,25 +19,25 @@ const CHUNK_SIZE = 1024 * 1024 * 0.25 // 0.25MB
export function parseSpreadsheetText({
text,
- treatEmptyAsNull = false,
+ emptyStringAsNullHeaders,
}: {
text: string
- treatEmptyAsNull?: boolean
+ emptyStringAsNullHeaders: Array<string> | undefined
}): Promise<{
headers: Array<string>
+ emptyStringAsNullHeaders: Array<string>
rows: Array<unknown>
previewRows: Array<unknown>
columnTypeMap: Record<string, InferredColumnType>
errors: Array<Papa.ParseError & { data: unknown }>
}> {
const columnTypeMap: Record<string, InferredColumnType> = {}
- let previewRows: unknown[] = []
+ let previewRows: Array<unknown> = []
return new Promise((resolve) => {
Papa.parse(text, {
header: true,
dynamicTyping: false,
skipEmptyLines: true,
- transform: treatEmptyAsNull ? (value: string) => (value === '' ? null : value) : undefined,
complete: (results) => {
const headers = results.meta.fields || []
const rows = results.data
@@ -52,8 +52,32 @@ export function parseSpreadsheetText({
}
})
- previewRows = results.data.slice(0, 20)
- resolve({ headers, rows, previewRows, columnTypeMap, errors })
+ const resolvedEmptyStringAsNullHeaders = emptyStringAsNullHeaders
+ ? emptyStringAsNullHeaders.filter((header) => headers.includes(header))
+ : headers
+
+ const transformedRows =
+ resolvedEmptyStringAsNullHeaders.length > 0
+ ? rows.map((row) => {
+ const rowAsObject = isObject(row) ? row : {}
+ return Object.fromEntries(
+ Object.entries(rowAsObject).map(([k, v]) => [
+ k,
+ v === '' && resolvedEmptyStringAsNullHeaders!.includes(k) ? null : v,
+ ])
+ )
+ })
+ : rows
+
+ previewRows = transformedRows.slice(0, 20)
+ resolve({
+ headers,
+ emptyStringAsNullHeaders: resolvedEmptyStringAsNullHeaders,
+ rows: transformedRows,
+ previewRows,
+ columnTypeMap,
+ errors,
+ })
},
})
})
@@ -67,17 +91,19 @@ export function parseSpreadsheetText({
export const parseSpreadsheet = (
file: File,
onProgressUpdate: (progress: number) => void,
- treatEmptyAsNull = false
+ emptyStringAsNullHeaders: Array<string> | undefined
): Promise<
Omit<SpreadsheetData, 'rows'> & {
previewRows: Array<unknown>
+ emptyStringAsNullHeaders: Array<string>
errors: Array<Papa.ParseError & { data: unknown }>
}
> => {
- let headers: string[] = []
+ let headers: Array<string> = []
+ let resolvedEmptyStringAsNullHeaders: Array<string> | undefined = emptyStringAsNullHeaders
let chunkNumber = 0
let rowCount = 0
- let previewRows: unknown[] = []
+ let previewRows: Array<unknown> = []
const columnTypeMap: Record<string, InferredColumnType> = {}
const errors: (Papa.ParseError & { data: unknown })[] = []
@@ -92,17 +118,27 @@ export const parseSpreadsheet = (
chunkSize: CHUNK_SIZE,
chunk: (results) => {
headers = results.meta.fields ?? []
+ // Default to all headers selected for empty string → null
+ // transformation if no specific headers were provided, otherwise
+ // filter down to only the allowed headers
+ resolvedEmptyStringAsNullHeaders = resolvedEmptyStringAsNullHeaders
+ ? resolvedEmptyStringAsNullHeaders.filter((header) => headers.includes(header))
+ : headers
// transform option is silently ignored when worker: true, so we apply
// the empty → null conversion manually here instead
- const data = treatEmptyAsNull
- ? results.data.map((row) => {
- const rowAsObject = isObject(row) ? row : {}
- return Object.fromEntries(
- Object.entries(rowAsObject).map(([k, v]) => [k, v === '' ? null : v])
- )
- })
- : results.data
+ const data =
+ resolvedEmptyStringAsNullHeaders.length > 0
+ ? results.data.map((row) => {
+ const rowAsObject = isObject(row) ? row : {}
+ return Object.fromEntries(
+ Object.entries(rowAsObject).map(([k, v]) => [
+ k,
+ v === '' && resolvedEmptyStringAsNullHeaders!.includes(k) ? null : v,
+ ])
+ )
+ })
+ : results.data
headers.forEach((header) => {
const type = inferColumnType(header, data)
@@ -131,7 +167,15 @@ export const parseSpreadsheet = (
onProgressUpdate(progress > 1 ? 100 : Number((progress * 100).toFixed(2)))
},
complete: () => {
- const data = { headers, rowCount, previewRows, columnTypeMap, errors }
+ const data = {
+ headers,
+ emptyStringAsNullHeaders:
+ emptyStringAsNullHeaders?.filter((header) => headers.includes(header)) ?? headers,
+ rowCount,
+ previewRows,
+ columnTypeMap,
+ errors,
+ }
resolve(data)
},
})
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImportPreview.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImportPreview.tsx
index 43f060af323..5f9513e226a 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImportPreview.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetImportPreview.tsx
@@ -24,6 +24,7 @@ interface SpreadsheetImportPreviewProps {
errors?: any[]
selectedHeaders: string[]
incompatibleHeaders: string[]
+ emptyStringAsNullHeaders: string[]
}
export const SpreadsheetImportPreview = ({
@@ -32,6 +33,7 @@ export const SpreadsheetImportPreview = ({
errors = [],
selectedHeaders,
incompatibleHeaders,
+ emptyStringAsNullHeaders,
}: SpreadsheetImportPreviewProps) => {
const [expandPreview, setExpandPreview] = useState(false)
const [expandedErrors, setExpandedErrors] = useState<string[]>([])
@@ -112,7 +114,12 @@ export const SpreadsheetImportPreview = ({
</div>
<div className="mb-4">
{previewHeaders.length > 0 && previewRows.length > 0 ? (
- <SpreadsheetPreviewGrid height={350} headers={previewHeaders} rows={previewRows} />
+ <SpreadsheetPreviewGrid
+ height={350}
+ headers={previewHeaders}
+ rows={previewRows}
+ emptyStringAsNullHeaders={emptyStringAsNullHeaders}
+ />
) : (
<div className="flex items-center justify-center py-4 border border-control rounded-md space-x-2">
<AlertCircle size={16} strokeWidth={1.5} className="text-foreground-light" />
@@ -218,6 +225,7 @@ export const SpreadsheetImportPreview = ({
<SpreadsheetPreviewGrid
headers={spreadsheetData.headers}
rows={[errorData]}
+ emptyStringAsNullHeaders={emptyStringAsNullHeaders}
/>
)}
</li>
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetPreviewGrid.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetPreviewGrid.tsx
index f003d23a5d6..38442b8e99f 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetPreviewGrid.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/SpreadsheetPreviewGrid.tsx
@@ -8,12 +8,14 @@ interface SpreadsheetPreviewGridProps {
headers: string[]
rows?: any[]
height?: number
+ emptyStringAsNullHeaders?: string[]
}
const SpreadsheetPreviewGrid = ({
headers = [],
rows = [],
height,
+ emptyStringAsNullHeaders = headers,
}: SpreadsheetPreviewGridProps) => {
const previewHeaders = headers.slice(0, MAX_HEADERS)
const previewRows = rows.slice(0, MAX_ROWS)
@@ -39,10 +41,17 @@ const SpreadsheetPreviewGrid = ({
</div>
),
renderCell: ({ row }: { row: any }) => {
- const isEmpty = row[header] === null || row[header] === undefined
+ const value = row[header]
+ const isEmptyString = value === ''
+ const isNullValue =
+ value === null ||
+ value === undefined ||
+ (isEmptyString && emptyStringAsNullHeaders.includes(header))
return (
- <span className={cn('text-sm flex items-center', isEmpty && 'text-foreground-light')}>
- {isEmpty ? 'NULL' : row[header]}
+ <span
+ className={cn('text-sm flex items-center', isNullValue && 'text-foreground-light')}
+ >
+ {isNullValue ? 'NULL' : value}
</span>
)
},
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/useSpreadsheetImport.ts b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/useSpreadsheetImport.ts
index abad9790e75..70243b17d90 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/useSpreadsheetImport.ts
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/SpreadsheetImport/useSpreadsheetImport.ts
@@ -31,6 +31,7 @@ interface FileParsedState {
_tag: 'file_parsed'
file: File
selectedHeaders: Array<string>
+ emptyStringAsNullHeaders: Array<string>
data: SpreadsheetData
errors: Array<Papa.ParseError & { data: unknown }>
}
@@ -39,6 +40,7 @@ interface TextParsedState {
_tag: 'text_parsed'
text: string
selectedHeaders: Array<string>
+ emptyStringAsNullHeaders: Array<string>
data: SpreadsheetData
errors: Array<Papa.ParseError & { data: unknown }>
}
@@ -123,8 +125,6 @@ export function useSpreadsheetImport({
}
})
- const [treatEmptyAsNull, setTreatEmptyAsNull] = useState(false)
-
const handleSwitchTab = useCallback(
function switchTab() {
if (isFileTab(state)) {
@@ -147,14 +147,20 @@ export function useSpreadsheetImport({
}, [])
const processFile = useCallback(
- async function processFile(file: File, { treatEmptyAsNull }: { treatEmptyAsNull: boolean }) {
+ async function processFile(
+ file: File,
+ { emptyStringAsNullHeaders }: { emptyStringAsNullHeaders?: Array<string> }
+ ) {
const currentSignal = resetAbortController()
- const { headers, rowCount, columnTypeMap, errors, previewRows } = await parseSpreadsheet(
- file,
- setParseProgress,
- treatEmptyAsNull
- )
+ const {
+ headers,
+ emptyStringAsNullHeaders: resolvedEmptyStringAsNullHeaders,
+ rowCount,
+ columnTypeMap,
+ errors,
+ previewRows,
+ } = await parseSpreadsheet(file, setParseProgress, emptyStringAsNullHeaders)
if (currentSignal.aborted) return
if (errors.length > 0) {
@@ -165,6 +171,7 @@ export function useSpreadsheetImport({
_tag: 'file_parsed',
file,
selectedHeaders: headers,
+ emptyStringAsNullHeaders: resolvedEmptyStringAsNullHeaders,
data: { headers, rows: previewRows, rowCount, columnTypeMap },
errors,
})
@@ -173,11 +180,20 @@ export function useSpreadsheetImport({
)
const processText = useCallback(
- async function processText(text: string, { treatEmptyAsNull }: { treatEmptyAsNull: boolean }) {
+ async function processText(
+ text: string,
+ { emptyStringAsNullHeaders }: { emptyStringAsNullHeaders: Array<string> | undefined }
+ ) {
const currentSignal = resetAbortController()
- const { headers, rows, columnTypeMap, errors } = await parseSpreadsheetText({
+ const {
+ headers,
+ emptyStringAsNullHeaders: resolvedEmptyStringAsNullHeaders,
+ rows,
+ columnTypeMap,
+ errors,
+ } = await parseSpreadsheetText({
text,
- treatEmptyAsNull,
+ emptyStringAsNullHeaders,
})
if (currentSignal.aborted) return
@@ -189,6 +205,7 @@ export function useSpreadsheetImport({
_tag: 'text_parsed',
text,
selectedHeaders: headers,
+ emptyStringAsNullHeaders: resolvedEmptyStringAsNullHeaders,
data: { headers, rows, rowCount: rows.length, columnTypeMap },
errors,
})
@@ -215,7 +232,7 @@ export function useSpreadsheetImport({
// latest state/treatEmptyAsNull without re-triggering the effect.
const processOnMount = useStaticEffectEvent(async function processOnMount() {
if (state._tag === 'parsing_file') {
- await processFile(state.file, { treatEmptyAsNull })
+ await processFile(state.file, { emptyStringAsNullHeaders: undefined })
}
})
useEffect(() => {
@@ -223,32 +240,27 @@ export function useSpreadsheetImport({
}, [processOnMount])
const processSpreadsheet = useCallback(
- async function processSpreadsheet({ treatEmptyAsNull }: { treatEmptyAsNull: boolean }) {
+ async function processSpreadsheet({
+ emptyStringAsNullHeaders,
+ }: {
+ emptyStringAsNullHeaders: Array<string> | undefined
+ }) {
if (hasAttachedFile(state)) {
- return processFile(state.file, { treatEmptyAsNull })
+ return processFile(state.file, { emptyStringAsNullHeaders })
} else if (hasAttachedText(state)) {
- return processText(state.text, { treatEmptyAsNull })
+ return processText(state.text, { emptyStringAsNullHeaders })
}
},
[state, processFile, processText]
)
- const handleToggleTreatEmptyAsNull = useCallback(
- function toggleTreatEmptyAsNull() {
- const next = !treatEmptyAsNull
- setTreatEmptyAsNull(next)
- processSpreadsheet({ treatEmptyAsNull: next })
- },
- [treatEmptyAsNull, processSpreadsheet]
- )
-
const handleUploadFile = useCallback(
async function uploadFile(file: File) {
markDirty(true)
setState({ _tag: 'parsing_file', file, progress: 0 })
- await processFile(file, { treatEmptyAsNull })
+ await processFile(file, { emptyStringAsNullHeaders: undefined })
},
- [treatEmptyAsNull, markDirty, processFile]
+ [markDirty, processFile]
)
const handleInputText = useCallback(
@@ -260,10 +272,13 @@ export function useSpreadsheetImport({
} else {
markDirty(true)
setState({ _tag: 'parsing_text', text, progress: 0 })
- await processTextDebounced(text, { treatEmptyAsNull })
+ await processTextDebounced(text, {
+ emptyStringAsNullHeaders:
+ state._tag === 'text_parsed' ? state.emptyStringAsNullHeaders : undefined,
+ })
}
},
- [treatEmptyAsNull, resetAbortController, markDirty, processTextDebounced]
+ [state, resetAbortController, markDirty, processTextDebounced]
)
const handleRemoveFile = useCallback(
@@ -283,18 +298,31 @@ export function useSpreadsheetImport({
const selectedHeaders = state.selectedHeaders.includes(header)
? state.selectedHeaders.filter((h) => h !== header)
: [...state.selectedHeaders, header]
- setState({ ...state, selectedHeaders })
+ const emptyStringAsNullHeaders = state.emptyStringAsNullHeaders.filter((h) =>
+ selectedHeaders.includes(h)
+ )
+ setState({ ...state, selectedHeaders, emptyStringAsNullHeaders })
}
},
[state]
)
+ const handleSetEmptyStringAsNullHeaders = useCallback(
+ function setEmptyStringAsNullHeaders(headers: string[]) {
+ if (state._tag === 'file_parsed' || state._tag === 'text_parsed') {
+ const nextHeaders = headers.filter((header) => state.selectedHeaders.includes(header))
+ processSpreadsheet({ emptyStringAsNullHeaders: nextHeaders })
+ setState({ ...state, emptyStringAsNullHeaders: nextHeaders })
+ }
+ },
+ [processSpreadsheet, state]
+ )
+
return {
state,
- treatEmptyAsNull,
handleSwitchTab,
- handleToggleTreatEmptyAsNull,
handleToggleSelectedHeader,
+ handleSetEmptyStringAsNullHeaders,
handleUploadFile,
handleInputText,
handleRemoveFile,
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.types.ts b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.types.ts
index 1c578a3546f..a5376da6fd1 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.types.ts
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.types.ts
@@ -7,18 +7,18 @@ export type TableField = Prettify<{
id: number
name: string
comment?: string | null
- columns: ColumnField[]
+ columns: Array<ColumnField>
isRLSEnabled: boolean
isRealtimeEnabled: boolean
}>
export interface ImportContent {
file?: File
- headers: string[]
+ headers: Array<string>
rowCount: number
rows: unknown[]
columnTypeMap: Dictionary<InferredColumnType>
- selectedHeaders: string[]
- treatEmptyAsNull: boolean
+ selectedHeaders: Array<string>
+ emptyStringAsNullHeaders?: Array<string>
resolve: () => void
}
diff --git a/apps/studio/tests/components/Editor/SpreadsheetImport.utils.test.ts b/apps/studio/tests/components/Editor/SpreadsheetImport.utils.test.ts
index 4eeeacc3791..25f9d7bd98c 100644
--- a/apps/studio/tests/components/Editor/SpreadsheetImport.utils.test.ts
+++ b/apps/studio/tests/components/Editor/SpreadsheetImport.utils.test.ts
@@ -76,28 +76,28 @@ interface SampleRow {
}
describe('SpreadsheetImport.utils: parseSpreadsheetText', () => {
- test('should keep empty cells as empty strings by default', async () => {
+ test('should keep empty cells as empty strings if no headers given', async () => {
const csv = `name,age\nJohn,25\nJane,`
- const { rows } = await parseSpreadsheetText({ text: csv })
+ const { rows } = await parseSpreadsheetText({ text: csv, emptyStringAsNullHeaders: [] })
expect((rows[1] as SampleRow).age).toBe('')
})
test('should convert empty cells to null when treatEmptyAsNull is true', async () => {
const csv = `name,age\nJohn,25\nJane,`
- const { rows } = await parseSpreadsheetText({ text: csv, treatEmptyAsNull: true })
+ const { rows } = await parseSpreadsheetText({ text: csv, emptyStringAsNullHeaders: undefined })
expect((rows[1] as SampleRow).age).toBeNull()
})
test('should not affect non-empty values when treatEmptyAsNull is true', async () => {
const csv = `name,age\nJohn,25\nJane,`
- const { rows } = await parseSpreadsheetText({ text: csv, treatEmptyAsNull: true })
+ const { rows } = await parseSpreadsheetText({ text: csv, emptyStringAsNullHeaders: undefined })
expect((rows[0] as SampleRow).name).toBe('John')
expect((rows[0] as SampleRow).age).toBe('25')
})
test('should handle multiple empty cells across columns when treatEmptyAsNull is true', async () => {
const csv = `name,age,city\nJohn,,\nJane,30,`
- const { rows } = await parseSpreadsheetText({ text: csv, treatEmptyAsNull: true })
+ const { rows } = await parseSpreadsheetText({ text: csv, emptyStringAsNullHeaders: undefined })
expect((rows[0] as SampleRow).age).toBeNull()
expect((rows[0] as SampleRow).city).toBeNull()
expect((rows[1] as SampleRow).age).toBe('30')
@@ -106,7 +106,10 @@ describe('SpreadsheetImport.utils: parseSpreadsheetText', () => {
test('should return correct headers regardless of treatEmptyAsNull', async () => {
const csv = `name,age\nJohn,25`
- const { headers } = await parseSpreadsheetText({ text: csv, treatEmptyAsNull: true })
+ const { headers } = await parseSpreadsheetText({
+ text: csv,
+ emptyStringAsNullHeaders: undefined,
+ })
expect(headers).toEqual(['name', 'age'])
})
})